NET/MASTER Network Control Language (NCL) Reference Manual

7 Message Profile Variables
106126 Tandem Computers Incorporated 7–1
After execution of the EMSREAD, INTREAD, LOGREAD, or MSGREAD verb
(referred to in this section as the xxx READ verbs), an entire suite of variables is set to
reflect the profile of the message that was read. These are known as the message
profile variables and are implemented as a mapped data object (MDO).
A message profile variable name starts with a prefix &$ xxx ., in which xxx represents
the first three letters of the verb that sets the variable. For example, if the message
profile variable &$ xxx .TEXT were set by EMSREAD, it would be known as
&$EMS.TEXT; if it were set by LOGREAD, it would be known as &$LOG.TEXT, and
so on.
This section describes the message profile variables set by the xxx READ verbs.
Depending on the setting of certain key variables, some profile variables are null; this
is noted in the description.
For help in understanding syntax notation, see “Notation Conventions” at the
beginning of this manual.
Message Profile
Variable Groups
Each message read by the xxxREAD verbs includes a number of message profile
variables. The variables describe different parts of the message that have been read by
the xxxREAD verb. These parts (or groups) are listed in Table 7-1.
In this section, the message profile variables are described as part of the group to
which they belong.
Table 7-1. List of Message Profile Variable Groups
Group Description
Communications network management
information
Contains CNM information about the message.
Display attributes of a message Contains information about the color, positioning,
highlighting, and other display characteristics of the
message text.
DOMID information Contains the unique identifier of non-roll-delete message.
Message text Contains the text of the message.
Prefix information variables Contains prefix information for the message.
Primary program operator (PPO)
information variables
Contains PPO information about the message.
Resource information variables Contains information about the resource that supplied the
message (if any).
Source information variables Contains information about the source of the message.
Subsystem Programmatic Interface
information variables
Contains SPI tokens if the message originated from EMS.
User map name Contains the map name of a user MDO.
User Mapped Data Object (MDO)
information
Contains the information provided in a user MDO.