File Utility Program (FUP) Management Programming Manual

ORSERV Commands and Responses
File Utility Program (FUP) Management Programming Manual—523322-001
5-19
Tokens in the Response Buffer
ZSPI-TKN-RESPONSE-TYPE and ZSPI-TKN-ALLOW-TYPE
are standard SPI response-control tokens. Although you can set these tokens, they
have no effect on the execution of the command.
ZSPI-TKN-COMMENT
is the standard SPI token that allows you to include an 80-byte arbitrary comment
in the command buffer. Although ORSERV ignores ZSPI-TKN-COMMENT in the
command buffer, the token can be useful when you are debugging an application.
Tokens in the Response Buffer
ZSPI-TKN-DATALIST
is the standard SPI token that begins a data list. Because ORSERV returns only
one response record per buffer, this response is enclosed in a data list if
ZSPI-TKN-MAXRESP has a value other than zero. The data list ends with
ZSPI-TKN-ENDLIST.
ZORS-TKN-FILE
specifies the target file that is the object of the SUSPEND command. Only one of
these tokens is returned in a response buffer. This token is in the Guardian internal
file-name format and is returned with every response.
ZSPI-TKN-RETCODE
is the standard SPI return token that is returned in the response buffer by all
Compaq subsystems. ZSPI-TKN-RETCODE contains zero if the command was
successful or an error number if an error or warning occurred.
When the SUSPEND command is executed, ZSPI-TKN-RETCODE can also have
these values:
•
ZORS-ERR-NO-ORELOAD (16)
An application specified the SUSPEND command for a target file, but an online
reload operation had not been previously initiated for the file.
•
ZORS-ERR-CANT-SUSPEND (17)
An application specified the SUSPEND command for a target file, but the
online reload operation cannot be suspended because an error occurred on:
°
The STOP procedure call when ORSERV tried to stop the process
performing the reload operation.
Zero ORSERV does not enclose the response in a data list.
Nonzero ORSERV encloses the response in a data list.