LOG - write data to log statement


[name] LOG {(data)}
           {AREA=area[,LENG=value]}
           {BLOCK=name}
           {DISPLAY}

Function

The LOG statement writes the user-specified data, data areas or control blocks, or the 3270 or 5250 display to the log data set for formatting by the Loglist Utility.

Where

name

Function: Specifies a name to be used when branching during message generation.

Format: From one to eight alphanumeric characters.

Default: None. This field is optional.

(data)

Function: Defines the data to be written in a message to the log data set.

Note: If you code this operand, it must be the only operand in the LOG statement.

Format: You can code any amount of data for this operand, but a maximum of 32767 characters of user data will actually be written to the log data set. The data is enclosed by the text delimiting character specified on the MSGTXT statement (the default is left and right parentheses). You can also continue the data. However, if a single delimiting character is detected in column 71, it indicates the end of the operand and data past column 71 is ignored.

You can use the data field options. (See Data field options.) Enter hexadecimal data by enclosing the digits within single quotes. To enter a single quote, the special control character (CONCHAR), or a text delimiting character (TXTDLM) as data, enter two of the characters. If you enter two text delimiting characters, they must be on the same statement (no continuation between the characters).

Default: None. If no data is entered, a null message will be logged.

AREA=area

Function: Specifies that a portion of a save area or user area is to be written to the log data set beginning with the specified offset.

Format: For the AREA operand, you can code one of the following options. value can be any integer from 0 to 32766 or a counter specification whose value is within this range. Zero is the offset to the first byte of the field for positive offsets (+value) and the offset to the last byte of the field for negative offsets (-value).

N±value: Specifies the area to be written at an offset from the start (+value) or back from the end (-value) of the network user area.
U±value: Specifies the area to be written at an offset from the start (+value) or back from the end (-value) of the device user area.
Ns+value: Specifies the area to be written at an offset from the start of the network save area, where s is the network save area and can be any integer from 1 to 4095.
s+value: Specifies the area to be written at an offset from the start of the device save area, where s is the device save area and can be any integer from 1 to 4095.

Default: None. This operand is optional.

BLOCK=name

Function: Specifies the name of a control block or data area to be written to the log data set.

Note: If you code the BLOCK operand, it must be the only operand in the LOG statement.

Format: For the BLOCK operand, you can code one of the following keywords:

CNT: Sequence and index counters
DEV: Device or logical unit control block
NCB: Network control block
SCR: Screen image for displays
SWS: Switches
TRM: Terminal control block

Default: None. This operand is optional.

DISPLAY

Function: Specifies that the display buffers are to be written to the log data set for formatting by the loglist program.

Note: If you code the DISPLAY operand, it must be the only operand on the LOG statement. The DISPLAY operand is valid only for 3270 and 5250 terminals.

Format: DISPLAY

Default: None. This operand is optional.

LENG=value

Function: Specifies the length of the data to be logged.

Note: The LENG operand is valid only if you also code the AREA operand.

Format: value can be an integer from 1 to 32767 or a counter specification whose value is within this range.

Default: The length from the offset specified by AREA to the end of the data in the save area or to the end of the user area.