CSLSCQRY: query request

CSLSCQRY parameters

ECB=symbol

ECB=(r1-r12)

(Optional) - Specifies the address of a z/OS® ECB used for asynchronous requests. When the request is complete, the ECB specified is posted. If an ECB is not specified, the task is suspended until the request is complete. If an ECB is specified, the invoker of the macro must issue a WAIT (or equivalent) after receiving control from CSLSCQRY, before using or examining any data returned by this macro (including the RETCODE and RSNCODE fields).

OUTLEN=symbol

OUTLEN=(r1-r12)

(Required) - Specifies a 4-byte field to receive the length of the output returned by the CSLSCQRY request. OUTLEN receives the length of the output pointed to by the OUTPUT= parameter.

The output length is zero if no output is built, for example, if an error is detected before any output can be built.

OUTPUT=output

OUTPUT=(r1-r12)

(Required) - Specifies a field to receive a pointer to the variable length output returned by the CSLSCQRY request. The output length is returned in the OUTLEN= field.

The output address is zero if no output was built, for example, if an error was detected before any output could be built.

The CSLSQRYO macro maps the output that is returned. The output contains a header and one or more list entries.

The output buffer is not preallocated by the caller. After being returned by the request, this word contains the address of a buffer containing the query output. It is the caller's responsibility to release this storage by issuing the CSLSCBFR FUNC=RELEASE request when it is through with the storage.

PARM=symbol

PARM=(r1-r12)

(Required) - Specifies the CSLSCQRY parameter list. The length of the parameter list must be equal to the parameter list length EQU value defined by SQRY_PARMLN.

PROTOCOL=RQST

(Optional) - SCI protocol for sending the request to SCI. RQST indicates that the SCI request interface protocol is to be used for the request.

RETCODE=symbol

RETCODE=(r1-r12)

(Required) - Specifies the address of a 4-byte field to receive the CSLSCQRY return code. SCI return codes are defined in CSLSRR. Possible return codes for CSLSCQRY are described in the following table.

RSNCODE=symbol

RSNCODE=(r1-r12)

(Required) - Specifies a 4-byte field to receive the reason code on output. SCI reason codes are defined in CSLSRR. Possible reason codes for CSLSCQRY are described in the following table.

SCITOKEN=symbol

SCITOKEN=(r1-r12)

(Required) - Specifies a 16-byte field containing the SCI token. This token uniquely identifies this connection to SCI. The SCI token was returned by a successful CSLSCREG FUNC=REGISTER request.

SCOPE=IMSPLEX

SCOPE=LOCAL

SCOPE=TYPE

(Optional) - Specifies the scope of information that is being requested.

IMSPLEX

This option returns data for all of the members in the IMSplex.

LOCAL

This option returns information for all of the members on the local z/OS image.

TYPE

This option returns information for all of the members that are of the specified IMSplex member type (and optionally subtype).

SUBTYPE=symbol

SUBTYPE=(r1-r12)

(Optional) - Four-byte input parameter that specifies the address of an 8-byte subtype that further qualifies the IMSplex member type about which information is being requested. This subtype is defined by the IMSplex member and was specified on the CSLSCREG request.

This parameter is valid only when SCOPE=TYPE.

TYPE=symbol

TYPE='AOP'

TYPE='BATCH'

TYPE='CQS'

TYPE='DBRC'

TYPE='IMS'

TYPE='IMSCON'

TYPE='ODBM'

TYPE='OM'

TYPE='OTHER'

TYPE='RM'

TYPE='SCI'

(Optional) - Specifies the IMSplex member type for which the query is being issued. SCI will return information for all of the members that are of the specified IMSplex member type (and, optionally, subtype). This parameter is required when SCOPE=TYPE.

If this parameter is passed as a literal, the literal must be enclosed in single quotation marks. If it is passed as a symbol, the symbol points to a word in storage that contains the code for the member type. If it is passed as a register, the register contains the member type code in the low-order half word of the register.

The code for the member type can be obtained by using the CSLSTPIX macro.

CSLSCQRY return and reason codes

The following table lists the return and reason codes that can be returned on a CSLSCQRY macro request. Also included is the meaning of a reason code (that is, what possibly caused it). In addition, CSLSCQRY can return any of the return codes listed in the following table.