Guardian Procedure Errors and Messages Manual

14 Subsystem Programmatic Interface (SPI) Errors
This section lists and describes the error numbers issued by the Subsystem Programmatic Interface
(SPI) procedures and the error lists associated with those procedures.
Error Codes
The following pages describe the SPI error numbers. These numbers are the values returned in the
status parameter on calls to the SPI procedures.
When any of these errors (except error 0 or error -1) occurs, the header token ZSPI-TKN-LASTERR
is set to the error number.
0 ZSPI-ERR-OK No error
Cause The operation completed successfully.
Effect The requested operation is complete.
Recovery Informative message only; no corrective action is needed.
-1 ZSPI-ERR-INVBUF Invalid buffer format
Cause The buffer supplied in the procedure call has an invalid format, as indicated by one or more
of the following:
• The first word of the buffer does not contain the correct message code
(ZSPI-VAL-MSGCODE=-28).
• The buffer is in a format not recognized by the current version of SPI.
• The used length of the buffer (ZSPI-TKN-USEDLEN) is greater than the maximum length
(Z-BUFLEN). Probably SSPUT was called with ZSPI-TKN-RESET-BUFFER and a maxlen value
that is smaller than ZSPI-TKN-USEDLEN.
• The buffer contains a ZSPI-TKN-ENDLIST token but no corresponding list token.
• The position descriptor within the buffer (ZSPI-TKN-POSITION) indicates a current list that does
not begin with a list token. Perhaps an incorrect position descriptor—one saved from another
buffer—was restored to ZSPI-TKN-POSITION in this buffer.
Effect The requested operation is not completed. Since the buffer format is invalid, the last error is
not saved.
Recovery Check for an incorrect buffer parameter or a corrupted buffer.
-2 ZSPI-ERR-ILLPARM Illegal parameter value
Cause A parameter supplied in the procedure call was illegal for one of the following reasons:
• SSINIT was called with an invalid header type.
• A negative index or count parameter was supplied.
• An attempt was made to use SSPUT or SSGET on a token using a count of zero.
• A call was made to one of the special operations that returns attributes of a token, but the
operation was applied to one of the special tokens. The special tokens that return attributes
are ZSPI-TKN-COUNT, ZSPI-TKN-LEN, ZSPI-TKN-OFFSET, and ZSPI-TKN-ADDR.
Error Codes 213