SPI Common Extensions Manual

Commands and Responses
SPI Common Extensions Manual—427508-001
5-49
LISTOBJECTS
LISTOBJECTS
ZCOM-CMD-LISTOBJECTS (nonsensitive)
The LISTOBJECTS command lists objects defined by or known to a subsystem. The
content of the response depends on the tokens specified in the command:
•
If the request contains ZSPI-TKN-OBJECT-TYPE set to ZCOM-OBJ-NULL, and
ZCOM-TKN-OBJNAME is missing or empty, the responses contain 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 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 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. Some subsystems
might not support this option. See the subsystem-specific management
programming manual.
LISTOBJECTS Command Tokens
ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32
or
ZCOM-TKN-XMGR token-type ZSPI-TYP-STRING
ZCOM-MAP-REQID
or
ZCOM-TKN-REQID-desc
ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING
ZCOM-TKN-SUB token-type ZSPI-TYP-ENUM
ZCOM-TKN-SEL-SUMSTATE token-type ZSPI-TYP-INT-PAIR
ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-TIMESTAMP
ZSPI-TKN-RESPONSE-TYPE token-type ZSPI-TYP-ENUM
ZSPI-TKN-ALLOW-TYPE token-type ZSPI-TYP-ALLOW-TYPE
ZSPI-TKN-COMMENT token-type ZSPI-TYP-STRING
ZSPI-TKN-CONTEXT token-type ZSPI-TYP-BYTESTRING