TCP/IP Management Programming Manual

Common Definitions
HP NonStop TCP/IP Management Programming Manual—529636-001
5-5
SPI Standard Definitions
specific error numbers described in Appendix A, Error Numbers and Error Lists.
This token is always present in an error list.
ZSPI-TKN-HDRTYPE
indicates whether the SPI buffer is for an event message or a command. If the
buffer is for a command, the value of this token is ZSPI-VAL-CMDHDR; if the buffer
is for an event, the value of this token is ZSPI-VAL-EVTHDR.
ZSPI-TKN-MAX-FIELD-VERSION
contains the latest version associated with the non-null fields within all extensible
structured tokens in a command. This value is compared with the server version. If
the server version is earlier than the value of ZSPI-TKN-MAX-FIELD-VERSION,
the command is rejected, because the server needs to be a more recent version.
ZSPI-TKN-MAXRESP
within a command buffer indicates the maximum number of response records a
requester can accept in a response buffer. The MAXRESP token default value is
provided when the requester uses the SSINIT procedure. However, if the requester
chooses to specify a value other than the default value for the MAXRESP token,
the requester must specify a value using the SSPUT procedure. The TCP/IP
interface provides full support for the MAXRESP token; that is, the requester can
specify any of these values:
ZSPI-TKN-OBJECT-TYPE
specifies the object-type number of a TCP/IP object. The value of this token for the
TCP/IP subsystem is always ZCOM-OBJ-type, where type specifies the object.
The valid object types for this subsystem are PROC, SUBNET, ROUTE, and
NULL. The object types associated with a command vary with each command. For
information on which objects are valid for a specific command, see Section 6,
Commands and Responses.
ZSPI-TKN-RETCODE
is the return token, which specifies whether a command has been completed
successfully. If a command has been completed successfully, including when a
command is completed with a warning, the value of this token is ZCOM-ERR-OK.
-1 indicates as many response records as will fit in the response buffer can be
returned. Each response record will be enclosed in a data list.
0 indicates only one response record will be returned in the response buffer.
The response record will not be enclosed in a data list. This is the default
action.
n indicates as many as n response records, where n is an integer greater than
0, will be returned in the response buffer. Each response record will be
enclosed in a data list.