NET/MASTER Network Control Language (NCL) Reference Manual

MSGREAD
Verbs
3–132 106126 Tandem Computers Incorporated
MSGREAD The MSGREAD verb reads the next available OCS message. This verb must be used
within a MSGPROC NCL procedure executing in an OCS environment. It requests
that processing of the MSGPROC procedure be suspended until the message is
available. You can use the MSGREAD verb to split the incoming OCS messages into
variables in a variety of forms, so that messages can be analyzed and interpreted.
If the MSGREAD verb is used within an NCL procedure other than a MSGPROC
procedure, a run-time error is issued.
You can conveniently place the MSGREAD verb in a DO loop within a MSGPROC
NCL procedure. Each message can then be inspected and appropriate action taken.
On completion of the MSGREAD verb, the &SYS.VARCNT system variable is set to
the number of variables created or modified by the operation.
When a MSGPROC NCL process terminates for any reason, standard message
processing is resumed.
The MSGREAD verb can store an enclosed MDO (for example, from the WRITE verb)
into a specified MDO variable.
MSGREAD [ ARGS [ PARSE={ NO | YES } ]
[ RANGE=( start , end ) ]
[ SEGMENT= n ] |
VARS={ input-vars-list | variable* }
[ PARSE={ NO | YES } ]
[ RANGE=( start , end ) ]
[ SEGMENT= n ] |
MDO=& mdo-name |
SET ]
[ DOM={ NO | YES } ]
[ TYPE={ ALL | SOLICIT | UNSOLICIT } ]
[ WAIT={ NO | YES | nnnn } ]
ARGS
specifies a range of generated variables for receiving the message. If too few
variables are specified, data is missing. Excess variables are given no value—they
are set to the null string. If the message contains an enclosed MDO mapped by
$NCL and PARSE=YES, NCL places the data in that MDO into variables, rather
than parsing the text.
PARSE
See “Frequently Occurring Operands,” at the beginning of this section, for
more information.