Call rtr_prepare_tx, Format, Description – Compaq AA-Q88CE-TE User Manual

Page 98

Advertising
background image

CALL RTR_PREPARE_TX

CALL RTR_PREPARE_TX

The CALL RTR_PREPARE_TX command causes a command server to execute
the

rtr_prepare_tx( )

routine and to display the returned status.

Format

CALL RTR_PREPARE_TX

Command Qualifiers

Defaults

/CHANNEL_NAME=channel-name

/CHANNEL_NAME=RTR$DEFAULT_CHANNEL

/DATA[=data]

/DATA=0

/NODE[=node-list]

/NODE=default-node-list

/OUTPUT[=file-spec]

/OUTPUT=stdout

/REASON[=reason]

/REASON=0

Description

The CALL RTR_PREPARE_TX command causes a command server to call the

rtr_prepare_tx( )

routine using values supplied on the command line.

The numeric status returned from the call is then converted to its textual
representation and displayed.

The

rtr_prepare_tx( )

routine itself is described in Application Programmer’s

Reference Manual.

The prototype of

rtr_prepare_tx( )

is:

rtr_status_t

rtr_prepare_tx (

rtr_channel_t

channel,

rtr_pre_flag_t

flags,

rtr_reason_t

reason

rtr_msgbuf_t

pmsg

rtr_msglen_t

msglen

) ;

Table 6–8 shows the correspondence between values you supply on the command
line and the C language parameter values produced and used for the call.

Table 6–8 Parameters for rtr_prepare_tx

C Parameter name

C Parameter Value

Command Line Specification

channel

/CHANNEL_NAME=name

flags

RTR_NO_FLAGS

[none] [D]

reason

RTR_NO_REASON

/NOREASON [D]

reason_value

/REASON=reason_value

pmsg, msglen

/ DATA=data

The CALL RTR_PREPARE_TX command causes a command server to execute
the rtr_prepare_tx( ) routine using the values supplied on the command line.
The numeric status returned from the call is then converted to its textual
representation and displayed.

6–22 RTR Command Line Interface

Advertising