beautypg.com

Call rtr_broadcast_event, Qualifiers – Compaq AA-Q88CE-TE User Manual

Page 83

background image

CALL RTR_BROADCAST_EVENT

Table 6–2 Parameters for rtr_broadcast_event

C Parameter Name

C Parameter Value

Command Line Specification

channel

/CHANNEL_NAME=name

flags

RTR_NO_FLAGS

[none] [D]

pmsg, msglen,
msgfmt

1

[message definition parameter list with positional
qualifiers. ]

evtnum

42

/EVENT_NUMBER=42

rcpspc

"workstat*"

/RECIPIENT_SPEC="workstat*"

1

The actual values used for

pmsg

,

msglen

and

msgfmt

are based upon the message definition you specify as a

command line parameter.

The command server uses message data specified as command line parameter
values to generate a record containing the message data (for the

pmsg

parameter),

the message length (for the

msglen

parameter), and a record type description (for

the

msgfmt

parameter).

Qualifiers

/CHANNEL_NAME=channel-name
/CHANNEL_NAME=RTR$DEFAULT_CHANNEL

Specifies the channel for which the operation is to be performed.

The command server uses a combination of the

channel_name

and the window

from which the call was issued to uniquely identify which channel to use.

channel_name

is not case sensitive.

The default for channel-name is RTR$DEFAULT_CHANNEL.

/CLUSTER
/NOCLUSTER (D)

Specifies that the command is executed on all the nodes in the cluster.

If neither

/NODE

nor

/CLUSTER

is specified then the command is executed on the

nodes specified by the latest

SET ENVIRONMENT

command. If no

SET ENVIRONMENT

command has been entered then the command is executed only on the node where
the command was issued.

Note: In environments that do not support clustering, use of the /CLUSTER
qualifier will cause the relevant command to be executed on the local node only.

/EVENT_NUMBER=user-event-number

The user event number associated with this broadcast, in the range of
RTR_EVTNUM_USERBASE to RTR_EVTNUM_USERMAX (i.e. 0 to 250).

/FORMAT[=fmt-string]
/NOFORMAT (D)

Specifies that a format string should be sent with this message.

If /FORMAT is specified without

fmt-string

, RTR automatically generates a

format string. The format string is generated using the parameters given for
the qualifiers /SIGNED, /UNSIGNED, /STRING and /LENGTH. The following
table shows permitted values for these qualifiers when using /FORMAT without

fmt-string

.

RTR Command Line Interface 6–7