File Utility Program (FUP) Management Programming Manual

ORSERV Programmatic Interface
File Utility Program (FUP) Management Programming Manual523322-001
4-3
Communicating With ORSERV
You can have only one ORSERV process open.
You must not open ORSERV using NOWAIT I/O.
The SYNC depth cannot be greater than one.
Check for any file-system errors after you open ORSERV. File-system errors
associated with applications using SPI include:
(Error 12) Your management process tried to open ORSERV more than once.
(Error 17) A problem occurred during the backup OPEN. This can occur when
the backup OPEN does not have a matching primary OPEN or if the backup
and primary OPEN parameters do not match.
(Error 28) The SYNC or NOWAIT depth is greater than one.
(Error 48) ORSERV rejects the OPEN because your user ID does not have the
proper authority to perform the OPEN. This can occur when the process trying
to open ORSERV is not the creator of the ORSERV process.
3. Send ORSERV a startup message.
When ORSERV reads the startup message, it ignores the IN file, the OUT file, the
default volume and subvolume, and the text portion. It also ignores the
AUTOSTOP parameter and any ASSIGN or PARAM messages.
4. Close ORSERV after you send the startup message.
5. Open ORSERV with #ZSPI as the first qualifier (in the process file name). The first
qualifier of the process file name for a backup OPEN must also be #ZSPI. If the
process name qualifier is not #ZSPI, you receive file-system error 11.
6. Allocate the command and response buffer.
The recommended minimum buffer length is ZORS-VAL-BUFLEN. A buffer of this
length is large enough to hold the command and response for all ORSERV
programmatic commands.
7. Initialize the command buffer.
Call the SSINIT procedure to specify the ORSERV command and initialize the
buffer (including the addition of header tokens).
Note. For a description of each file-system error, see the Guardian Procedure Errors
and Messages Manual.
Note. Although this manual refers to the SSINIT, SSNULL, SSGET, SSPUT, and SSMOVE
procedures, Compaq also provides the SSPUTTKN, SSGETTKN, and SSMOVETKN
procedures. These procedures have the same functions as SSPUT, SSGET, and
SSMOVE, and a calling sequence that is simpler for TAL programming.
For TACL programming, Compaq also provides the #SSINIT, #SSNULL, #SSGET,
#SSGETV, #SSPUT, #SSPUTV, and #SSMOVE built-in functions.