Guardian Procedure Calls Reference Manual

Table 8 CHECK^FILE Operations That Return Values (continued)
retvalState of Fileoperation
The device type and subtype are described in Appendix A:
Device Types and Subtypes. File types 0-3 are described in
the Enscribe Programmer’s Guide.
Returns the file number. If the file is not open, the file number
is -1.
OpenFILE^FNUM
if level-3 spooling is disabled.0OpenFILE^LEVEL3^SPOOLING
if level-3 spooling is enabled.1
if there is no logical I/O outstanding.0OpenFILE^LOGIOOUT
if a logical read is outstanding.1
if a logical write is outstanding2
Returns the open access for the file. See SET^FILE for the
format.
AnyFILE^O
Returns the open exclusion for the file. See SET^FILE for format.OpenFILE^OPENEXCLUSIONPENACCESS
to indicate that there is no outstanding physical I/O
operation.
0OpenFILE^PHYSIOOUT
if a physical I/O operation is outstanding.1
Returns the file's primary extent size in pages. The maximum
primary extent size is 65,535 pages. Otherwise, error 538
is returned.
AnyFILE^PRIEXT
if no error message is to be printed upon detection
of a fatal error in the file.
0OpenFILE^PRINT^ERR^MSG
if an error message is to be printed.1
Returns the interactive prompt character for the file in <9:15>.OpenFILE^PROMPT
if the user does not get an end-of-file (EOF) indication
when the process [pair] having this process open
closes it.
0OpenFILE^RCVEOF
if the user does get an EOF indication when this
process closes.
1
Returns a count of current openers of this process {0:2}. At any
given moment, openers are limited to a single process [pair].
OpenFILE^RCVOPENCNT
if the SIO procedures are to reply to the open
messages ($RECEIVE file).
0OpenFILE^RCVUSEROPENREPLY
if the user is to reply to the open messages.1
if the trailing blanks are not trimmed off the data
read from this file.
0OpenFILE^READ^TRIM
if the trailing blanks are trimmed.1
Returns the logical record length.AnyFILE^RECORDLEN
Returns the file's secondary extent size in pages. The maximum
secondary extent size is 65,535 pages. Otherwise, error 538
is returned.
AnyFILE^SECEXT
Returns a mask word indicating which system messages the
user handles directly. See SET^FILE for the format. 0 indicates
OpenFILE^SYSTEMMESSAGES
that the SIO procedures handle all system messages. Note that
this operation cannot check some of the newer system
CHECK^FILE Procedure 125