Subparameters for REQUEST=XSTATUS

REQUEST=XSTATUS
Returns status information on an XRC session. The information will be in the MESSAGES buffer.
,RETINFO=retinfo
A required output parameter field that is used to return detailed information about the results of executing the request. Information about the results of scheduling the request are returned in the RETCODE and RSNCODE fields. Align the area on a word boundary. The first 4-bytes contain the return code and the second 4-bytes contain the reason code. The remainder of the information is dependent on the return and reason codes. See the coding example SDM API usability guide about how to coordinate the RETCODE, RSNCODE, and RETINFO fields.

To code: Specify the RS-type address, or address in register (2)-(12), of a required 100-character output field.

,MESSAGES=messages
A required output parameter field in which ANTRQST will place the address of a buffer containing messages about the results of executing the request. These are the messages that would have been returned to the caller if the TSO interface had been used. If there are no messages, the address will be zero.
An ANTRQST message buffer has the following format:
  • Bytes 1-4 contain the size of the ANTRQST message buffer.
  • Byte 5 contains the subpool of the ANTRQST message buffer.
  • Byte 6 is not used.
  • Bytes 7-8 contain the number of messages in the array that follows.

The rest of the message buffer is an array of messages. Each message has the following format:

  • Bytes 1-2 contain the size of the message in bytes 3-x.
  • Bytes 3-x contain the message.

To code: Specify the RS-type address, or address in register (2)-(12), of a required 4-character field.

,ECB=ecb
,ECB=NO_ECB
An optional input parameter field that SDM posts for an asynchronous request. This field is ignored for synchronous requests.

The default is NO_ECB.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field.

,ETYPE=etype
,ETYPE=ADDRSPACE
Specifies that XRC display the names of all active XRC address spaces in the LPAR, including the session name, the address space name and identifier, the type of session, the associated cluster name, and associated master session name.
,ETYPE=etype
,ETYPE=CLUSTER
Specifies that SDM display information about coupled XRC sessions associated with the cluster session in the LPAR where the command is processed, including the cluster session name, XRC session name, session status, volume status, interlock status, journal delta time, RCV/ADV delta time, master session name and HLQ, maximum journal delta for all sessions in the cluster session, and maximum RCV/ADV delta time for all sessions in the cluster session.
,MHLQ=mhlq
,MHLQ=SYS1
An optional input parameter field containing the high level qualifier of the Master Control data set. The name is left justified and padded on the right with blanks. If the field contains binary zeros, the default is used. This field is used only if the MASTER option is specified in the ETYPE keyword.

The default is SYS1.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,WAITTIME=waittime
,WAITTIME=0
An optional halfword input parameter field containing how long in seconds SDM will wait for a request to complete. A value of zero says to not time the request. If the time expires before the request is complete a value of 7039 (RQST_WAITTIME_EXPIRED [see ANTRQSTL]) will be returned. If the request is a synchronous request, the value will be placed in the return code part of RETINFO. If the request is an asynchronous request, the value will be used as the ECB post code.

The default is 0.

To code: Specify the RS-type address, or address in register (2)-(12), of an optional halfword input field.

DATASET
Specifies that XRC direct the XSTATUS output to the sequential data set that is identified by dataset_name. Standard TSO naming conventions apply for dataset_name. The target data set must be a sequential data set and must be large enough to accommodate the XSTATUS reports you want to collect. You can specify DATASET with or without DISP; the default is DISP(OLD).
Allocate a data set for the XSTATUS function with the following attributes:
DCB=(RECFM=FB,LRECL=80,BLKSIZE=6400,DSORG=PS)
DISP
Specifies how XRC writes the XSTATUS output to the data set, as follows:
MOD
Specifies that XRC append the output to the data set.
OLD
Specifies that XRC clear the data set before it receives output.
SHR
Specifies that XRC clear the data set before it receives output. SHR also allows multiple allocations of the same data set.

If you specify DISP, you must also specify DATASET.

MSGROUTEID
Specifies the user ID to which XRC messages that are associated with the processing of this command are routed. If the specified user ID is not logged on, TSO saves messages in the TSO BRODCAST data set and displays them after the next logon.
Note: Messages issued by the initial command parser routine are sent to the user ID that issues the TSO command. If you specify both DATASET and MSGROUTEID, XQUERY output is directed to the data set that is specified with DATASET and not to the MSGROUTEID user ID. Error messages are directed to the MSGROUTEID user ID.