SPI Common Extensions Manual

ZCMK Definitions
SPI Common Extensions Manual—427508-001
B-45
LISTOBJECTS
LISTOBJECTS
This subsection describes how ZCMK-based subsystems process LISTOBJECTS
commands.
If the request contains ZSPI-TKN-OBJECT-TYPE set to ZCOM-OBJ-NULL, ZCOM-
TKN-OBJNAME is not allowed in the request. Neither is ZCOM-TKN-SUB allowed in
the request unless it contains the default value ZCPM-VAL-SUB-NONE. The
responses list all the objects known to the subsystem.
If the request contains ZSPI-TKN-OBJECT-TYPE set to a type (ZCOM-OBJ-objtype)
other than NULL and ZCOM-TKN-OBJNAME is missing or empty, the responses
contain all the objects of the specified type that are known to the subsystem.
ZCOM-TKN-SUB is not allowed in the request unless it contains the default value
ZCPM-VAL-SUB-NONE.
If the request contains ZSPI-TKN-OBJECT-TYPE set to a type (ZCOM-OBJ-objtype)
other than NULL and ZCOM-TKN-OBJNAME contains an object name template, the
responses contain all the objects of the specified type that are known to the subsystem
and have names that match the template. ZCOM-TKN-SUB is not allowed in the
request unless it contains the default value ZCPM-VAL-SUB-NONE.
LISTOPENS
A ZCMK-based subsystem returns the tokens listed here in response to a LISTOPENS
command that is directed to the subsystem’s native object type. The response buffer is
valid only if it is large enough to contain the entire list of openers or if segmented
responses are allowed. In the case of segmented responses, each segment list
contains the description of one open.
ZCMK-TKN-LISTOP-XPNAME
records the process name of an opener. The nth occurrence of ZCMK-TKN-
LISTOP-XPNAME corresponds to the nth occurrence of ZCMK-TKN-LISTOP-
QUALIFS and ZCMK-MAP-LISTOP.
LISTOPENS Response Tokens
ZCMK-TKN-LISTOP-XPNAME token-type ZSPI-TYP-STRING
ZCMK-TKN-LISTOP-QUALIFS token-type ZSPI-TYP-STRING
ZCMK-MAP-LISTOP
or
ZSPI-TKN-SEGLIST token-type ZSPI-TYP-LIST
ZCMK-TKN-SEGTYPE token-type ZSPI-TYP-ENUM
ZCMK-TKN-LISTOP-XPNAME token-type ZSPI-TYP-STRING
ZCMK-TKN-LISTOP-QUALIFS token-type ZSPI-TYP-STRING
ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL