Previous Topic: Message Profile Variables

Next Topic: &LOGREAD Message Profile

&INTREAD Message Profile

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

&ZINTYPE

Specifies whether an &INTREAD operation has been satisfied by a request message or a response message. Values are REQ (request message) or RESP (response message) or NONE (no message).

&ZMALARM

Indicates whether the message will cause the terminal alarm to sound. Value is YES or NO, or null if &ZINTYPE=REQ.

&ZMALLMSG

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

&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 &ZINTYPE=REQ.

&ZMDOM

Indicates whether the message is a delete operator message instruction. Value is YES or NO. This value is dependent also on the setting of the &ZMTYPE variable.

&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 or &ZINTYPE=REQ, this variable is set to null.

&ZMEVONID

Is set when the incoming message was generated by an &EVENT verb and contains the nclid of the procedure which issued the &EVENT.

&ZMEVPROF

Is set for incoming event messages (N00102) and represents the EDS profile name which resulted in delivery of the event notification.

&ZMEVRCDE

Contains the routecde of the incoming event message (N00102), if the ROUTECDE operand was specified on the originating &EVENT verb.

&ZMEVTIME

Is set for incoming event messages (N00102) to the time the event originated. Time is in the format HH.MM.SS.TTT.

&ZMEVUSER

Is set when the incoming message was generated by an &EVENT verb and contains the userid of the user who issued the &EVENT verb. This variable is also set for some system events and represents the user who was responsible for the event generation.

&ZMFTSMSG

Indicates whether the message originated from the File Transmission Services (FTS) optional feature. Value is YES or NO, or null if &ZINTYPE=REQ.

&ZMHLIGHT

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

&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 &ZINTYPE=REQ.

&ZMLNODE

Always null.

&ZMLOGCMD

Always null.

&ZMLSRCID

Contains the message prefix of the last handler of the message just received.

&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 &ZINTYPE=REQ.
&ZMLTIME

Always null.

&ZMLUSER

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. This attribute is null if &ZINTYPE=REQ.

&ZMMSG

Indicates whether the message received is a standard message or not. The setting of this variable is always opposite to the setting of the &ZMDOM variable and is dependent on the setting of the &ZMTYPE variable. This attribute is null if &ZINTYPE=REQ.

&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 &ZINTYPE=REQ.

&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 &ZINTYPE=REQ.

&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 &ZINTYPE=REQ.

&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. Will be null if &ZINTYPE=REQ.

&ZMREQID

If &ZINTYPE=REQ (&INTREAD satisfied by a request message), this variable is set to the user ID of the user that issued the INTQUE command that generated the request message, or to the NCL ID of the NCL process that issued the INTQUE command. This variable is dependent on &ZINTYPE for relevance, and its setting is categorized by the &ZMREQSRC variable which will also be set. (This is available to &INTREAD only.)

This attribute is null if &ZINTYPE=RESP.
&ZMREQSRC

If &ZINTYPE=REQ (&INTREAD satisfied by a request message), this variable indicates whether the source of the INTQUE command that generated the message was a user or another NCL process. Values are USER or NCL respectively. (This is available to &INTREAD only.)

This attribute is null if &ZINTYPE=RESP.
&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 &ZINTYPE=REQ.

&ZMSOURCE

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

&ZMTEXT

Contains the text of the message received. This attribute is null if &ZMTYPE=DOM.

&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.