Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (F)
Guardian Procedure Calls Reference Manual522629-013
5-131
FILE_OPEN_CHKPT_ Procedure
status output
INT .EXT:ref
returns a value indicating the cause of the file-system error returned in
error.
Values are:
0 Backup open succeeded (
error is 0)
1 File was opened in backup with warning
2 Open failed in backup
3 Unable to communicate with backup
4 Error occurred in primary
Considerations
Identification of the backup process
The system identifies the backup process to be affected by FILE_OPEN_CHKPT_
from the process’s mom field in the process control block (PCB). For named
process pairs, this field is automatically set up during the creation of the backup
process.
Nowait opens with FILE_OPEN_CHKPT_
If a process is opened in a nowait manner (
options.<1> = 1 in the call to
FILE_OPEN_), the backup open is also performed in a nowait manner. It must be
completed by a call to AWAITIO[X], in which case the
error and status values
are available through FILE_GETINFOLIST_ items 7 and 8, respectively. If you
specify the
tag parameter to AWAITIO[X], the returned value is -29D; the returned
count and buffer address are undefined.
Opens performed through the use of DEFINEs
If the primary process opens a file through the use of a DEFINE, that DEFINE must
exist unchanged when FILE_OPEN_CHKPT_ is called.
Local setmode operations
All local setmode operations (that is, setmodes that are supported by
CHECKSETMODE) that have been applied to the file since the original open are
also applied to the file by FILE_OPEN_CHKPT_.
SQL/MX objects
FILE_OPEN_CHKPT_ cannot be called for an SQL/MX object.
See “Considerations” for the FILE_OPEN_ procedure.
Example
error := FILE_OPEN_CHKPT_ ( file^number, status );