Arguments

 

pasteboard-id

   OpenVMS usage:identifier
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference

   Specifies the pasteboard to be checked for the presence of a
   broadcast message. The pasteboard-id argument is the address of
   an unsigned longword that contains the pasteboard identifier.

   The pasteboard identifier is returned by SMG$CREATE_PASTEBOARD.
 

message

   OpenVMS usage:char_string
   type:         character string
   access:       write only
   mechanism:    by descriptor

   A string that receives the broadcast message, if such a message
   is available. The message argument is the address of a descriptor
   that points to the string into which the message text is written.
   If this argument is omitted, the broadcast message is discarded.
 

message-length

   OpenVMS usage:word_unsigned
   type:         word (unsigned)
   access:       write only
   mechanism:    by reference

   Receives the actual length of the broadcast message. The message-
   length argument is the address of an unsigned word into which is
   written the length of the message.
 

message-type

   OpenVMS usage:word_unsigned
   type:         word (unsigned)
   access:       write only
   mechanism:    by reference

   Receives the type of broadcast message. The message-type argument
   is the address of an unsigned word into which is written the type
   of message. Values for message-type are defined by the $MSGDEF
   library definition. If the value for message-type is not MSG$_
   TRMBRDCST, the condition value returned is SMG$_NOBRDMSG.