Guardian Procedure Calls Reference Manual

Table 8 CHECK^FILE Operations That Return Values (continued)
retvalState of Fileoperation
messages; for these, use operation
FILE^SYSTEMMESSAGESMANY.
Returns the word address within the FCB of a four-word mask
indicating which system messages the user handles directly.
OpenFILE^SYSTEMMESSAGESMANY
See SET^FILE for the format. A return of all zeros indicates that
the SIO procedures handle all system messages.
if the P-relative address is not appended to all SIO
error messages.
0AnyFILE^TRACEBACK
if the P-relative address is appended to all SIO error
messages.
1
Returns the user flag word. (See SET^FLAG procedure,
SET^USERFLAG operation.)
AnyFILE^USERFLAG
if records longer than the logical record length are
truncated.
0OpenFILE^WRITE^FOLD
if long records are folded.1
if a record shorter than the logical record length is
not padded with trailing blanks before it is written
to the file.
0OpenFILE^WRITE^PAD
if a short record is padded with trailing blanks.1
if trailing blanks are not trimmed from data written
to the file.
0OpenFILE^WRITE^TRIM
if trailing blanks are trimmed.1
Table 9 describes operations that return addresses. For native callers, addresses are returned in
the ret-addr parameter. For other callers, addresses are returned in retval.
Table 9 CHECK^FILE Operations That Return Addresses
ret-addr (for native callers) retval (for other callers)State of Fileoperation
Returns the address of the FCB pointed to by the backward link
pointer within the FCB. This indicates the linked-to FCBs that need
to be checkpointed after an OPEN^FILE or CLOSE^FILE call.
AnyFILE^BWDLINKFCB
Returns the word address of the duplicate file FCB. 0 is returned if
there is no duplicate file.
OpenFILE^DUPFILE
Returns the word address within the FCB where the error code is
stored. FILE^ERRORFILE Any returns the word address within the
FCB of the reporting error file. 0 is returned if there is none.
AnyFILE^ERROR^ADDR
Returns the address of the FCB.AnyFILE^FCB^ADDR
Returns the word address within the FCB of the physical file name.AnyFILE^FILENAME^ADDR
Returns the word address within the FCB of the file number.AnyFILE^FNUM^ADDR
Returns the address of the FCB pointed to by the forward link pointer
within the FCB. This value indicates the linked-to FCBs that need to
be checkpointed after an OPEN^FILE or CLOSE^FILE call.
AnyFILE^FWDLINKFCB
Returns the word address within the FCB of the logical file name.
The logical file name is encoded as follows:
AnyFILE^LOGICALFILENAME^ADDR
ContentsByte Number
<len> is the length of the logical file name in
bytes {0:8}
[0]
126 Guardian Procedure Calls (C)