File Utility Program (FUP) Management Programming Manual

FUP Programmatic Interface
File Utility Program (FUP) Management Programming Manual—523322-001
2-16
Receiving and Decoding a Response Buffer
Each data list contains a ZSPI-TKN-RETCODE token to indicate the error status of the
response for a specific file.
Figure 2-6 on page 2-16 shows a single response record in a data list. The error list is
present only if an error occurred, as indicated by ZSPI-TKN-RETCODE.
Figure 2-6. Single FUP Record in a Data List
Warnings that apply to the FUP command (and not to the file) are returned in the first
response record. If the command can be continued, the reply buffer contains the
context token ZSPI-TKN-CONTEXT, which is not part of a data list. Similar to the single
response record, ZSPI-TKN-CONTEXT indicates whether FUP has returned the last
response record. Each request has a value for ZSPI-TKN-MAXRESP (either the
specified value or zero if a value is not specified). FUP does not save this value for
subsequent requests.
Controlling Types of Response Records
The SPI token ZSPI-TKN-RESPONSE-TYPE controls the types of response records
that FUP returns in the buffer. The values for ZSPI-TKN-RESPONSE-TYPE are:
ZSPI-VAL-ERR-AND-WARN
FUP returns a response record only for a file that caused an error or a warning.
The response buffer contains at least one error list, regardless of the value of
ZSPI-TKN-RETCODE.
ZSPI-VAL-ERR-WARN-AND-NORM
FUP returns a response record for each file processed. The default is ZSPI-VAL-
ERR-WARN-AND-NORM.
If the value of ZSPI-TKN-RESPONSE-TYPE is ZSPI-VAL-ERR-AND-WARN, and the
command does not encounter any errors or warnings, FUP returns an empty response
(with ZSPI-TKN-RETCODE set to ZFUP-ERR-EMPTY-RESP).
ZSPI-TKN-DATALIST
ZSPI-TKN-RETCODE
ZFUP-TKN-FILE
token-1
token-2
.
.
.
token-n
error-list (if an error occurred)
ZSPI-TKN-ENDLIST
Note. For more information about an empty response, see Tokens in a Single FUP Response
Record on page 2-14