Previous Topic: &INTREAD Message Profile

Next Topic: &MSGREAD Message Profile

&LOGREAD Message Profile

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

&ZMALARM

Indicates whether the message will cause the terminal alarm to sound. Value is YES or NO.

&ZMALLMSG

Indicates whether the message was generated by a MSG ALL command. Value is YES or NO.

&ZMCOLOUR

Indicates the color attribute of the message. Value can be any one of NONE, RED, BLUE, GREEN, YELLOW, TURQUOISE, PINK, or WHITE.

&ZMDOM

Value is always 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.

&ZMHLIGHT

Indicates the display highlighting attributes of the message. Values are NONE, USCORE, REVERSE, or BLINK.

&ZMINTENS

Indicates the display intensity attribute of the message. Values are HIGH or LOW or null if no message being processed.

&ZMLNODE

Indicates the terminal name of the user to whom a log message is to be attributed. Value is the name of a terminal. (This is available to &LOGREAD only.)

&ZMLOGCMD

Indicates whether a log message is an echo to the log of a command. Value is YES or NO. (This is available to &LOGREAD only.)

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

&ZMLTIME

Contains the timestamp of a log message. Time is in the format HH.MM.SS.TTT.

&ZMLUSER

Contains the user ID to whom generation of the log message is to be attributed.

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

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

&ZMOSRCTP

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

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

&ZMPTEXT

Value is always null.

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

&ZMSOURCE

Indicates the verb that last set the values of the message profile variables. This will always be LOGREAD for the &LOGREAD 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.

After &LOGREAD, this variable does not include the standard log message heading information of user ID, time, and terminal name. These values are available from other message profile variables that are set after &LOGREAD.

&ZMTYPE

Value is always MSG.