As indicated previously, you
must specify the RETINFO subparameter
for every ANTRQST request, and optionally, you may specify the RETCODE
and RSNCODE subparameters to get return code and reason codes placed
in specific fields in addition to the RETINFO area. Register 15 (and
optionally the RETCODE area) will contain the return code from scheduling
the request. Register 0 (and optionally the RSNCODE area) will contain
the reason code from scheduling the request.
The first eight
bytes of the RETINFO area contain the execution
diagnostic return and reason codes - the first four bytes contain
the return code and the second four bytes contain the reason code.
The information in the remaining part of the RETINFO area is dependent
on the request. Reference the prolog of the appropriate macro that
is used for the request, as previously mentioned in topic 'SDM
API Macros', to determine the information
returned for the request.
If you specify the REQUEST=LEVEL
subparameter, the ANTRQST macro
will return a number indicating the level of SDM API support. The
level number will be returned in the first four bytes of the RETINFO
area. Reference the prolog of the ANTRQSTL macro to determine the
meaning of the number.
Each of the four ILK types provides data
for different query information
requests. All of these except the ILK=XRC requests of REQUEST=XQUERY
and REQUEST=XSTATUS use the subparameters of QRYINFO and QRYSIZE.
These two XRC query requests use the MESSAGES subparameter value
to return requested information. For all query requests, you must
specify the required subparameter in order that SDM may provide the
requested information.
- QRYINFO
- The value specified with the QRYINFO
subparameter provides the
area into which the SDM API will place the query information requested.
SDM determines the amount of data returned based on the value specified
on the QRYSIZE value specified.
- QRYSIZE
- The value specified on the QRYSIZE
subparameter provides the
size of the area indicated by the QRYINFO specified subparameter value.
- MESSAGES
- The ILK=XRC requests provide
variable amounts of information.
Therefore, the area needed to return information and messages for
these requests is first determined by SDM. SDM gathers the information,
and then allocates the area in the application program's address space
sufficient to hold all of this information. The value specified with
the MESSAGES subparameter is a four byte field into which SDM will
place the address of this allocated area. For XRC requests, the information
is returned in the form of XRC messages.
The information in the
allocated area is provided as following format:
- Bytes 1-4 contain the size of the allocated area.
- Byte
5 contains the subpool of the allocated area.
- Byte 6 is
not used.
- Bytes 7-8 contain the number of messages in the
array that follows.
The rest of the allocated area 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.
- DSNAME/DSDISP
- Some of the requests (for
example, REQUEST=RQUERY) allow specifying
a data set name and optionally a data set disposition. The status
messages will be written to the data set instead of placed in the
QRYINFO or MESSAGES data area. In this situation QRYSIZE should not
be specified.