WAN Manager SPI Programming Guide

Commands and Response Tokens
WAN Manager SPI Programming Guide—540013-001
4-3
Description of Header Tokens
ZSPI-TKN-COMMAND
contains the command number. Its value is in the format ZCOM-CMD-command
and is specified in the call to SSINIT (for example, ZCOM-CMD-START).
ZSPI-TKN-LASTERR
records the last nonzero status code returned by an SPI procedure when
processing the buffer. This value is set by the procedure that detects the error and
can be retrieved by calling the SSGET procedure. This value can be cleared using
the special SSPUT operation ZSPI-TKN-CLEARERR.
ZSPI-TKN-LASTERRCODE
records the token code of the token involved in the last nonzero status code
returned by an SPI procedure when processing the buffer. This value is set by the
procedure that detects the error and can be retrieved by calling the SSGET
procedure. The value is of the format: (zspi-tdt-token-datatype,
token-length, token-num).
ZSPI-TKN-MAX-FIELD-VERSION
contains the latest version of a nonnull field in any extensible structured token
added to the buffer. The maximum field version is kept for version compatibility
checking by subsystems. This value is checked by SSPUT, and reset if necessary
each time it puts an extensible structure into the buffer. The value can be retrieved
using SSGET.
ZSPI-TKN-MAXRESP
specifies the maximum number of response records that the requester accepts in a
single response message. The requester can specify any of these values:
If the value of this command header token is not zero, the response record is
encapsulated in a data list (between the ZSPI-TKN-DATALIST and
ZSPI-TKN-ENDLIST tokens). Multiple response records are supported. The default
value for this token is 0 (zero).
Value Description
0 Enables the server to return one response record per response
message, with the record not enclosed in a data list. This is the default
value.
>0 Enables the server to return as many as n response records in the
response message, with each record enclosed in a data list. This is a
limit and not an absolute value. The server might return fewer than n
records in the message.
-1 Enables the server to return as many response records as can be fit in
the buffer, with each record enclosed in a data list.