File Utility Program (FUP) Management Programming Manual

ORSERV Programmatic Interface
File Utility Program (FUP) Management Programming Manual—523322-001
4-13
Discontinuing a Command in Progress
ORSERV accepts a single file name as the object of a command. The name cannot be
a file set or file-set list.
You specify the target file name in the ZORS-TKN-FILE token. The file name must be
in the Guardian internal file-name format and must be fully qualified. If the file is not on
the same system as ORSERV, the name must be in Guardian network internal file-
name format. If a file name does not include a system identifier, ORSERV assumes
that the file is on the same system that ORSERV is running. All file names returned by
ORSERV in the response buffer are also in the Guardian internal file-name format.
Discontinuing a Command in Progress
ORSERV does not check for CANCEL requests from an application that executes the
CANCEL file-system procedure. You must start another ORSERV process and send it
a SUSPEND command to suspend a reload operation.
Receiving and Decoding a Response Buffer
When your application receives the response buffer, first check for these errors and
take an appropriate action (if an error occurs):
•
Errors that were reported by the method used to send and receive the buffer, such
as a file-system error
•
ZSPI-TKN-RETCODE token for a value indicating that ORSERV found an error in
the command
•
Used-length token ZSPI-TKN-USEDLEN from the response buffer to ensure that
the buffer is not larger than the buffer allocated by your application
You might also want to check the values of these tokens in the message header to
ensure that the response matches the original command:
After these checks are made, you can extract the remaining tokens from the buffer and
continue processing.
Note. For more information about the Guardian internal file-name format, see the Guardian
Programmer’s Guide.
Note. For more information, see the description of the SUSPEND Command
on page 5-18.
ZSPI-TKN-COMMAND ORSERV command number from the original request
ZSPI-TKN-OBJECT-TYPE ORSERV object type number from the original request
ZSPI-TKN-SSID Subsystem ID of the ORSERV server that performed the
command
ZSPI-TKN-SERVER-VERSION Release version of the ORSERV server that performed
the command