File Utility Program (FUP) Management Programming Manual

ORSERV Programmatic Interface
File Utility Program (FUP) Management Programming Manual—523322-001
4-15
Handling ORSERV Errors
•
All of the ORSERV errors (including a cause and recovery for each error) in
Appendix C, ORSERV Error Messages.
An error list begins with ZSPI-TKN-ERRLIST and ends with ZSPI-TKN-ENDLIST. Each
error list describes an error or warning. The ZSPI-TKN-ERROR error token, which is
included in the error list, specifies the error that occurred. Other tokens in the error list
describe other components of the error, such as the ORSERV command and the file
ORSERV was processing when the error occurred.
If ZSPI-TKN-RETCODE is zero, the response buffer can still contain an error list. This
error list is a warning describing a condition you might want to know about—although
the condition did not prevent ORSERV from performing the requested command. To
determine the warning, enter the error list and check the value of the ZSPI-TKN-
ERROR token.
Figure 4-5 shows an example of an ORSERV error list. The tokens are not necessarily
in the same order as the ones displayed here.
The tokens in the error list are:
•
ZSPI-TKN-ERROR
This token contains the ORSERV subsystem ID and the error number. ZSPI-TKN-
ERROR is always present in an error list.
•
Error-description tokens
These optional tokens (token-1, token-2, through token-n) describe the error.
•
Nested error lists
ORSERV returns a second nested error list when the error originates from another
subsystem or software component (such as the Guardian file system).
Types of ORSERV Errors
These types of errors can occur when your application sends a command buffer to
ORSERV:
•
Syntax errors in the ORSERV command format
Figure 4-5. Tokens in an Error List
ZSPI-TKN-ERRLIST
ZSPI-TKN-ERROR
token-1
token-2
.
.
.
token-n
nested error list, if another subsystem error occurs
ZSPI-TKN-ENDLIST