Access z/OS® Communications Server logon data.
EXTRACT LOGONMSG >>-EXTRACT LOGONMSG--+-INTO(data-area)-+--LENGTH(data-area)---->< '-SET(ptr-ref)----'
Condition: NOTALLOC
Description
EXTRACT LOGONMSG accesses z/OS Communications Server logon data. This data may have been specified by the terminal operator at logon or in the ISSUE PASS command, for example. This data is only available if the system initialization parameter LGNMSG=YES is specified. The data can only be extracted once. It is possible to force the first transaction that runs on the terminal to be that which issues EXTRACT LOGONMSG by using the the system initialization parameter GMTRAN.
All the logon data is extracted and its length placed in the field specified by the LENGTH option. Because the LENGTH option cannot be used to limit the amount of data extracted, it is recommended that a field of 256 bytes is always used for this option.
If you use the SET option, the z/OS Communications Server logon data is not freed until the session terminates (CLSDST). If you use the INTO option, the z/OS Communications Server logon data is copied into user storage and then freed.
Options
- INTO(data-area)
- specifies the receiving field for the data extracted.
- LENGTH(data-area)
- specifies the length, as a halfword binary value, of the data extracted. If no data is available, LENGTH is set to zero.
- SET(ptr-ref)
- specifies
the pointer reference that is to be set to the address of the data
extracted. The pointer reference, unless changed by other commands
or statements, is valid until the next EXTRACT LOGONMSG command or
the end of task.
If DATALOCATION(ANY) is associated with the application program, the address of the data can be above or below the 16MB line.
If DATALOCATION(BELOW) is associated with the application program, and the data resides above the 16MB line, the data is copied below the 16MB line, and the address of this copy is returned.
If TASKDATAKEY(USER) is specified for the running task, and storage protection is active, the data returned is in a user-key. If TASKDATAKEY(CICS®) is specified and storage protection is active, the data returned is in a CICS-key.
Conditions
- 61 NOTALLOC
- occurs
if the facility specified in the command is not owned by the application.
Default action: terminate the task abnormally.
