SPI Common Extensions Manual

Commands and Responses
SPI Common Extensions Manual—427508-001
5-7
Common Response Tokens
ZSPI-TKN-RETCODE
indicates the outcome of command processing. Possible values are:
This token is always present in the response.
ZCOM-TKN-OBJTYPE
specifies the object type for ZCOM-TKN-OBJNAME.
ZCOM-TKN-OBJNAME
specifies an object name for each object acted upon by the command.
subsys-type-name
represents a subsystem-defined token. A response description containing this
symbol indicates that subsystem-defined tokens are allowed in that particular
response. For the specific tokens, see the appropriate subsystem management
programming manual.
ZSPI-TKN-ERRLIST
indicates the beginning of an error list. ZSPI-TKN-ENDLIST indicates the end of
the list. An error list is put into a response for each error or warning that occurred
during processing of the command. Error lists can be nested.
ZSPI-TKN-ERROR
specifies the error and identifies the subsystem that prepared the error list.
This token is always present in an error list.
ZCOM-TKN-OBJTYPE
contains the type of the object involved in the error.
ZCOM-TKN-OBJNAME
contains the name of the object involved in the error.
ZSPI-TKN-CONTEXT
indicates by its presence that not all response records generated by the command
have been returned. Another response message is required. Your application
should move ZSPI-TKN-CONTEXT to a copy of the original command message
and send the command again to retrieve the next response message.
0 (ZCOM-ERR-OK) No error occurred during command processing. If a warning
occurred, the response contains an error list that specifies the
warning.
<>0 An error occurred during command processing. If an error
occurred, the response contains an error list that specifies the
error.