File Utility Program (FUP) Management Programming Manual

FUP Programmatic Interface
File Utility Program (FUP) Management Programming Manual—523322-001
2-14
Receiving and Decoding a Response Buffer
You should also check the values of these tokens in the SPI message header to
ensure that the response matches the original command:
If no errors are found, you can extract the remaining tokens from the buffer and
continue processing.
Processing a Single Response Record
The default FUP command and response is a single FUP command that generates
one response record per reply buffer. The response record describes the action of the
command on one file.
Continuing a FUP Command
The CHECKSUM and DUPLICATE commands (without the restartable option
specified) accept a file-set template for the source file name. Although this allows each
command to process more than one file, each reply message applies only to a single
file (by default). This causes each reply to contain the response for the file that FUP
processed most recently and the ZSPI-TKN-CONTEXT context token. This token
indicates that FUP has not finished processing all the files in the file set.
ZSPI-TKN-COMMAND FUP command from the request.
ZSPI-TKN-OBJECT-TYPE Object type from the request.
ZSPI-TKN-SSID Subsystem ID of the FUP server that performed the command.
Figure 2-4. FUP Single Response Record
ZSPI-TKN-RETCODE
ZFUP-TKN-FILE
token-1
token-2
.
.
.
token-n
error-list (if an error occurs)
Table 2-5. Tokens in a Single FUP Response Record
ZSPI-TKN-RETCODE token This token reports any errors or warnings. A value of zero
indicates the command was successful. A value other than
zero indicates an error or warning occurred.
ZFUP-TKN-FILE token This token identifies the object of the command (such as
the file or file set).
FUP response tokens These tokens (token-1, token-2, through token-n) are
specific to the FUP command.
Error lists If any errors or warnings occurred, the error or warning
information is enclosed in one or more error lists.