Guardian Procedure Calls Reference Manual

These literals can be combined using signed addition because bit 0 is not used:
PURGE^DATAKEEP^LASTOPENTIMEABORT^OPENERR
READ^TRIMLEVEL3^SPOOL^ENABLEABORT^XFERERR
VAR^FORMATMUSTBENEWAUTO^CREATE
WRITE^FOLDNOWAITAUTO^TOF
WRITE^PADOLD^RECEIVEBLOCKED
WRITE^TRIMPRINT^ERR^MSGCRLF^BREAK
For the meanings of literals used with flags, see Considerations (page 911). Literal declarations
are contained in the file $SYSTEM.SYSTEM.GPLDEFS.
flags-mask
input
INT(32):value
specifies which bits of the flag field are used to alter the file transfer characteristics. A
characteristic to be altered is indicated by entering a 1 in the bit position corresponding to the
flags parameter. A 0 indicates the default setting is used. If this parameter is omitted, all
positions are treated as zeros.
max-recordlen
input
INT:value
specifies the maximum record length for records within this file. If this parameter is omitted,
the maximum record length is 132.
The open is aborted with an SIOERR^INVALIDRECLENGTH, error 520, if the file's record length
exceeds the maximum record length and max-recordlen is not 0. If max-recordlen is 0,
then any record length is permitted.
prompt-char
input
INT:value
specifies the interactive prompt character for reading from terminals or processes. "?" is the
default prompt. The prompt character is limited to seven bits, <9:15>.
error-file-fcb
input
INT:ref:*
if present, specifies a file where error messages are displayed for all files. Only one
error-reporting file is allowed per process. The file specified in the latest OPEN^FILE call is the
one used. Omitting this parameter does not alter the setting of the current error-reporting file.
The default error-reporting file is the home terminal.
If the error-reporting file is not open when needed, it is opened only for the duration of the
message printing, then closed. Remember that the error-reporting file FCB must be initialized.
For information about the file FCB, see the Guardian Programmer's Guide.
Returned Value
INT
A file-system or SIO procedure error code that indicates the outcome of the call.
If the abort-on-open-error mode is in effect (the default situation), the only possible value is 0.
910 Guardian Procedure Calls (O)