Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (R)
Guardian Procedure Calls Reference Manual—522629-013
13-12
READ^FILE Procedure
6 System message (only if user requested system messages through
SET^SYSTEMMESSAGES or SET^SYSTEMMESSAGESMANY)
111 Operation aborted because of BREAK (if BREAK is enabled). If
nowait
is not zero, and if abort-on-error is in effect, the only possible value for
error is 0.
file-fcb input
INT:ref:*
identifies the file to be read.
buffer output
INT:ref:*
is where the data is returned. The buffer must be located within ‘G’[ 0:32767 ]
process data area.
count-returned output
INT:ref:1
returns the number of bytes returned to
buffer. If I/O is nowait, this parameter
has no meaning and can be omitted. The count is then obtained in the call to
WAIT^FILE.
prompt-count input
INT:value
is a count of the number of bytes in
buffer, starting with element zero, to be used
as an interactive prompt for terminals or interprocess files. If omitted, the
interactive prompt character defined in OPEN^FILE is used.
max-read-count input
INT:value
specifies the maximum number of bytes to be returned to
buffer. If omitted or if it
exceeds the file’s logical record length, the logical record length is used for this file.
nowait input
INT:value
indicates whether or not to wait for the I/O operation to complete in this call. If
omitted or zero, then “wait” is indicated. If not zero, the I/O operation must be
completed in a call to WAIT^FILE.