&MAISGET

The &MAISGET verb retrieves details of the specified session into user variables.

Use the verb to access the attributes of session list entries or the defaults. You can also use the verb to mark a session as the current session for &MAISCMD.

This verb has the following format:

&MAISGET { ID=sessid | RELNUM=nn | DEFAULTS }
         [ PREFIX={ MAI | prefix} ]
         [ ATTR={ ANY | LIST } ]
         [ FIELDS={ name | ( name1,name2,...,namen ) } ] 
         [ PAD ] }

Operands:

ID=sessid

Specifies the one- to eight-character session identifier that uniquely identifies a defined MAI-FS session to access.

RELNUM=nn

Specifies the numerical position of a relative session within the user's session list to access.

DEFAULTS

Retrieves the default MAI-FS session characteristics.

PREFIX={ MAI | prefix }

(Optional) Specifies the prefix for the user variables to access. The user variable names are formed by concatenating the PREFIX operand value with the field names specified on the FIELDS operand.

Default: MAI

ATTR={ ANY | LIST }

(Optional) Specifies whether the attributes of the active session are returned, or those attributes of the session list entry only. ATTR=LIST returns the attribute values of the session list entry. If an active session is available, ATTR=ANY returns the attribute values of the session; otherwise, the attributes of the session list entry are returned.

FIELDS={ name | name1,name2,...,namen }

(Optional) Specifies the field names of the user variables to return. The user variable names are formed by concatenating the PREFIX operand value with the field names specified on this operand. The following table shows the fields that are specified on this operand:

Field Name	Description	Values Returned
DESC	Session description	String
DEFD	DEFLOGON description	String or N53D03 message
SSTAT	Session status	RUNNING, WAITING, ENDED, <->
SHIDE	Session visibility	HIDDEN, SLEEPING, null
SOUTW	Session output status	OUTPUT, null
SWNDO	Active window of session	1, 2,- (- meaning not active)
NODE	Specific virtual terminal	Null or 1- to 8-character name
LOGON	Logon string	1 through 50 characters
SESS	Session identifier	1 through 8 characters
FJMP1/2	Jump forward key	Null or Fnn/PFnn/PAn/ATTN
RJMP1/2	Jump reverse key	Null or Fnn/PFnn/PAn/ATTN
MENU1/2	Jump to menu key	Null or Fnn/PFnn/PAn/ATTN
SISM	Screen Image Services menu key	Null or Fnn/PFnn/PAn/ATTN
SISP	Screen print key	Null or Fnn/PFnn/PAn/ATTN
SWAP1/2	Swap to other window key	Null or Fnn/PFnn/PAn/ATTN
REST	Restart option	Y or N
WAIT	Wait option	Y or N
FJUMP	Fast jump option	Y or N
COMP	Compression option	Y or N
LMODE	Specific logmode	Null or 1- to 8-character name
SCTPR	Script name and option	Null or 1- to 8-character name

PAD: (Optional) Returns the fields with their default maximum length.

Return Codes:

On completion, the &RETCODE system variable is set as follows:

0: The function completed successfully and the variables are set.
4: An error in the request was detected. &SYSMSG is set to indicate the error condition. No user variables are updated.

Note:

When the verb accesses a session list entry, the session is marked as the current session. A subsequent &MAISCMD verb affects this session.