SPI Common Extensions Manual

ZCMK Definitions
SPI Common Extensions Manual427508-001
B-36
Token Occurrence and Value Tests
Token Occurrence and Value Tests
ZCMK-based subsystems perform the following token-specific tests on all SPI
requests. ZSPI, ZCOM, and ZCMK tokens not listed in the table are not allowed in
requests and results in ZCOM-ERR-TKN-CODE-INV.
Test Result If Test Fails
Retrieve the next token, allowing for end-of-buffer. Error: ZCOM-ERR-SPI-ERR
Event: ZCMK-EVT-SPI-SSCALL
The token’s SSID matches that of the subsystem. Error: ZCOM-ERR-SSID-INV
Retrieve the address and length of the token. Error: ZCOM-ERR-SPI-ERR
Compare the token number to the list of recognized
tokens.
Error: ZCOM-ERR-TKN-CODE-INV
For tokens that can appear only once, verify that
this occurrence is the first.
Error: ZCOM-ERR-TKN-DUP
Verify that the token is allowed to appear in the
specified command (ignoring object type).
Error: ZCOM-ERR-TKN-CODE-INV
For simple (nonmapped) tokens, verify that the type
and length values agree with those known to the
subsystem.
Error: ZCOM-ERR-TKN-CODE-INV
For simple variable-length tokens, verify that length
does not exceed that specified by the subsystem.
Error: ZCOM-ERR-TKN-LEN-INV
For mapped tokens, verify that the buffer contains
token data type STRUCT.
Error: ZCOM-ERR-TKN-CODE-INV
If value rules exist for the token, test them. Error: ZCOM-ERR-TKN-VAL-INV
ZCOM-ERR-OBJNAME-INV
Other *
* If the rules are defined by ZCMK, ZCOM-ERR-OBJNAME-INV is returned for tokens tested by the object-
name test, and ZCOM-ERR-TKN-VAL-INV is returned for all other tests. If the rules are defined by the
subsystem, other errors can be returned, but ZCOM-ERR-TKN-VAL-INV is typically used.
Token Test
ZCMK-TKN-ALTER Allowed only in ALTER commands.
ZCMK-TKN-ALTER-BKUP-CPU Value is in the range -1…15. Only allowed in ALTER
commands.
ZCMK-TKN-ALTER.ZBKUP-
DEBUG
Value is 1, 0, or blanks.
ZCMK-TKN-ALTER.ZDEBUG-
ON-ERR
Value is 1, 0, or blanks.
ZCMK-TKN-CHMAP-NAME Allowed only in ALTER and ADD commands. Text
contains no nonblanks following the first blank.
ZCMK-TKN-CHMAP-XFNAME Length does not exceed ZSYS-VAL-LEN-FILENAME.