beautypg.com

Call rtr_broadcast_event – Compaq AA-Q88CE-TE User Manual

Page 82

background image

CALL RTR_BROADCAST_EVENT

CALL RTR_BROADCAST_EVENT

The CALL RTR_BROADCAST_EVENT command causes a command server to
execute the

rtr_broadcast_event( )

routine and to display the returned status.

Format

CALL RTR_BROADCAST_EVENT [message-field1] [,message-field2...]

Parameters

[message-field1] [,message-field2...]

Specify the message to be sent (if any) as one or more comma separated
parameter values. You can use the /TYPE_OF_DATA and /LENGTH_OF_DATA
positional qualifiers on each parameter value to specify the data type and length
of each field.

Command Qualifiers

Defaults

/CHANNEL_NAME=channel-name

/CHANNEL_NAME=RTR$DEFAULT_CHANNEL

/CLUSTER

/NOCLUSTER

/EVENT_NUMBER=evtnum

none

/FORMAT=fmt-string

/NOFORMAT

/LENGTH_OF_FIELD=message lengthDepends on data type; see description.
/NODE[=node-list]

/NODE=default-node-list

/OUTPUT[=file-spec]

/OUTPUT=stdout

/RECIPIENT_SPEC=rcpspc

/NORECIPIENT_SPEC

/TYPE_OF_DATA=data type

/TYPE_OF_DATA=STRING

Description

The CALL RTR_BROADCAST_EVENT command causes a command server to

call the

rtr_broadcast_event( )

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_broadcast_event( )

routine itself is described in Application

Programmer’s Reference Manual.

The prototype of

rtr_broadcast_event( )

is:

rtr_status_t rtr_broadcast_event (

rtr_channel_t

channel,

rtr_bro_flag_t

flags,

rtr_msgbuf_t

pmsg,

rtr_msglen_t

msglen,

rtr_evtnum_t

evtnum,

rtr_rcpspc_t

rcpspc,

rtr_msgfmt_t

msgfmt

) ;

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

6–6 RTR Command Line Interface