System Level Procedures: Message Profiles › &MSGREAD Message Profile

&MSGREAD Message Profile

The message profile variables set following &MSGREAD are as follows. Depending on the setting of certain key variables, some profile variables can be null.

&ZMALARM

Indicates terminal alarm. Values are YES or NO.

&ZMALLMSG

Indicates whether the message was generated by a MSG ALL command. Value is YES or NO, or null if &ZMTYPE=DOM.

&ZMCOLOUR

Indicates the color attribute of the message. Value can be any one of NONE, RED, BLUE, GREEN, YELLOW, TURQUOISE, PINK, or WHITE. This attribute is null if &ZMTYPE=DOM.

&ZMDOM

If &ZMTYPE=DOM, value is DOM; otherwise, it is NO.

&ZMDOMID

Contains the delete operator message identifier (domid) of the message read, if the message has the non-roll delete message attribute, as determined by the setting of the &ZMNRD variable. If &ZMNRD=NO, this variable is set to null.

&ZMFTSMSG

Indicates whether the message originated from the File Transmission Services (FTS) optional feature. Value is YES or NO. This attribute is null if &ZMTYPE=DOM.

&ZMHLIGHT

Indicates the display highlighting attributes of the message. Values are NONE, USCORE, REVERSE, or BLINK. This attribute is null if &ZMTYPE=DOM.

&ZMINTENS

Indicates the display intensity attribute of the message. Values are HIGH or LOW or null if no message being processed. This attribute is null if &ZMTYPE=DOM.

&ZMLOGCMD

Value is always null.

&ZMLNODE

Value is always null.

&ZMLSRCID

Contains the message prefix of the last handler of the message just received. Values can be:

Null

Message generated internally by this system.

ROF msgid

Message prefix of the ROF session which delivered the message.

MAIOC sessionid

The session ID of the MAI OC session that delivered the message.

This attribute is null if &ZMTYPE=DOM.

&ZMLSRCTP

Indicates the type of the last handler of the message just received. Values can be:

Null

If the message was generated within this system.

ROF

If the message was delivered across a ROF session.

MAIOC

If the message was delivered across an MAI OC session.

This attribute is null if &ZMTYPE=DOM.

&ZMLTIME

Value is always null.

&ZMLUSER

Value is always null.

&ZMAPNAME

Contains the mapname of the object in $MSG.USERMDO for the current message (if present).

&ZMMONMSG

Indicates whether the message received is a monitor class message. Values are YES or NO.

&ZMMSG

Value is YES or NO.

&ZMNRD

Indicates whether the message carries the non-roll delete attribute. Values can be:

NO

Not a non-roll delete message.

YES

Message is non-roll delete and can be deleted only by a delete operator message (DOM) instruction.

OPER

If the message is non-roll delete but is deleted only by the cursor delete function from an OCS window.

&ZMOSRCID

Contains the message prefix of the originator of the message just received. Will be null if &ZMTYPE=DOM.

&ZMOSRCTP

Indicates the type of the originator of the message just received. Values can be:

Null

If the message was generated within this system.

ROF

If the message was delivered across a ROF session.

MAIOC

If the message was delivered across an MAI OC session.

This attribute is null if &ZMTYPE=DOM.

&ZMPREFXD

Indicates whether the message text has been prefixed with identifier values, for example MAI OC session identifier or ROF message prefix. Values are YES or NO. This attribute is null if &ZMTYPE=DOM.

&ZMPTEXT

Is set to the entire message text, prefixed with any ROF or MAI OC session identifiers according to the current profile settings, as it will appear on the OCS window if the message is allowed to flow to the window unchanged. This attribute is null if &ZMTYPE=DOM.

&ZMREQID

Value is always null.

&ZMREQSRC

Value is always null.

&ZMSOLIC

Indicates whether the message was solicited or unsolicited. A solicited message is usually a command response. Values are YES (solicited) or NO. This attribute is null if &ZMTYPE=DOM.

&ZMSOURCE

Indicates the verb that last set the values of the message profile variables. This will always be MSGREAD for the &MSGREAD message profile. The suite of message profile variables remain set until changed by the execution of another verb that modifies the suite.

&ZMTEXT

If &ZMTYPE=MSG, &ZMTEXT contains the entire message text. If &ZMTYPE=DOM, then &ZMTEXT is null.

&ZMTYPE

Specifies the type of message received after execution of the read verb. Values are:

MSG

The message is a standard text message.

DOM

The message is a delete operator message instruction.

REQ

The message is a request message that has satisfied &INTREAD TYPE=ANY or TYPE=REQ.

The value DOM is possible only if DOM=YES is coded on the &MSGREAD statement.