Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (C)
Guardian Procedure Calls Reference Manual—522629-013
3-18
CHECK^FILE Procedure
Considerations
•
During the execution of this procedure, the detection of any error causes the
display of an error message and the process is aborted.
•
This procedure is used to get the primary extent or secondary extent size of a file
that is no greater than 65,535 pages. If the primary and secondary extent sizes
are greater than 65,535, error 538 is returned.
•
Table 3-2 contains operations that return values returned in retval.
•
Table 3-3 contains operations that return addresses. For native callers, addresses
are returned in the
ret-addr parameter. For other callers, addresses are
returned in
retval.
•
In Table 3-2 and Table 3-3 the column labeled “State of File” can contain the
following:
Open The file must be open to obtain this characteristic.
Any The file can be either open or closed.
The following table describes operations that return values returned in
retval.
Table 3-2. CHECK^FILE Operations That Return Values (page 1 of 5)
operation
State
of File
retval
FILE^ABORT^XFERERR Open 0 if the process is not to abort upon
detection of a fatal error in the file.
1 if the process is to abort.
FILE^ASSIGNMASK1 Any Returns the high-order word of the
ASSIGN message field mask in the FCB.
This value generally has meaning only
after being set by the INITIALIZER
procedure.
FILE^ASSIGNMASK2 Any Returns the low-order word of the ASSIGN
message field mask in the FCB. This
value generally has meaning only after
being set by the INITIALIZER procedure.
FILE^BLOCKBUFLEN Any Returns a count of the number of bytes
used for blocking.