Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (O)
Guardian Procedure Calls Reference Manual—522629-013
11-30
OPEN^FILE Procedure
Parameters
error returned value
INT
returns a file-system or SIO procedure error number indicating the outcome of the
operation.
If the abort-on-open-error mode is in effect (the default situation), the only possible
value of
error is 0.
common-fcb input
INT:ref:*
is an array of FCBSIZE or FCBSIZE^D00 words for use by the SIO procedures.
Only one common file control block (FCB) is used per process. This means the
same data block is passed to all OPEN^FILE calls. The common FCB must be
initialized before the first call to OPEN^FILE following a process startup. The size
of the file control block differs between TNS processes and native processes.
file-fcb input
INT:ref:*
is an array of FCBSIZE or FCBSIZE^D00 words for use by the SIO procedures.
The file FCB uniquely identifies this file to other SIO procedures. The file FCB
must be initialized with the name of the file to be opened before OPEN^FILE is
called. The size of the file control block differs between TNS processes and
native processes.
Refer to the
Guardian Programmer’s Guide for information about the FCB
structure.
block-buffer input
INT:ref:*
is an array used for one of four different purposes:
•
When reading a structured file, the presence of this parameter indicates a request
for sequential block buffering. If more than one file refers to the same block-buffer
address, they share the same sequential block buffer.
•
When reading or writing an EDIT file, the buffer is used by SIO to contain EDIT file
pages being assembled or disassembled. The buffer must be supplied for an EDIT
file.
•
When using level-3 spooling, the buffer is used by SIO to hold records that are to
be sent to a spooler collector.