File Utility Program (FUP) Management Programming Manual

ORSERV Programmatic Interface
File Utility Program (FUP) Management Programming Manual—523322-001
4-14
Handling ORSERV Errors
Extracting Tokens From an ORSERV Response Record
An ORSERV command generates a single response record in the response buffer.
This response record describes the action of the ORSERV command on a single file.
Figure 4-4 shows a single ORSERV response record. The tokens are not necessarily
in the same order as the ones displayed here.
The tokens in a single response record are:
•
ORSERV response tokens
These tokens (token-1, token-2, through token-n) are specific to the ORSERV
command. For example, the STATUS command returns the ZORS-MAP-STATUS-
RESPONSE token.
•
ZSPI-TKN-RETCODE token
This token identifies any errors or warnings. A value of zero indicates that the
command was successful. A value other than zero indicates that an error or
warning occurred. A value of zero for the ONLINERELOAD command indicates
that the reload operation was initiated successfully.
•
ZORS-TKN-FILE token
This token identifies the object of the ORSERV command (the target file).
•
Error lists
If any errors or warnings occurred, the error or warning information appears in one
or more error lists.
Handling ORSERV Errors
If ZSPI-TKN-RETCODE indicates an error or warning (a value other than zero), the
response buffer contains one or more error lists. For the values that ZSPI-TKN-
RETCODE can return, see:
•
The errors common to all ORSERV commands in Table 4-4 on page 4-21
•
The individual ORSERV command descriptions, which display the errors that each
command can return
Figure 4-4. Tokens in a Response Buffer
token-1
token-2
.
.
.
token-n
ZSPI-TKN-RETCODE
ZORS-TKN-FILE
error list, if an error or warning occurs