COBOL Manual for TNS/E Programs (H06.08+, J06.03+)

library-reference
is a mnemonic-name in the SPECIAL-NAMES paragraph. This mnemonic-name is associated
with the DLL containing an object copy of COBOL_SPECIAL_OPEN_.
file-name
is the name of a COBOL data file; that is, a file described in a File Description entry. It must
be an FD name associated with a file-system file name that specifies a disk file (device type
3).
open-type
is a numeric operand whose value (after truncation to an integer value, if necessary) is 3. The
value 3 signifies the opening of a partitioned disk file, even though some partitions cannot be
accessed.
exclusion
is a numeric operand that specifies the exclusion attribute for the open operation. The evaluation
of this operand includes, if necessary, truncation to an integer value. If the parameter is present,
its value must be 0 (shared), 1 (exclusive), or 3 (protected); if it is omitted, the routine determines
the exclusion attribute from a command interpreter ASSIGN command (when one applies to
the specified FD-name); otherwise the routine assumes the value 3 (protected) when the open
mode is Input or assumes the value 1 (exclusive) for any other open mode.
sync-depth
is a numeric operand that specifies the sync-depth attribute for the open operation. The
evaluation of this operand includes, if necessary, truncation to an integer value. If this parameter
is present, it must be in the range 0 through 255; if it is omitted, the value assumed depends
on the nature of the file. For a disk file, the routine uses a value of 1.
time-limits
is a numeric operand that specifies the TIME-LIMITS attribute for the open operation. The
evaluation of this operand includes, if necessary, truncation to an integer value. The presence
of a nonzero value for this parameter is equivalent to the presence of a TIME LIMITS phrase
with a nonzero value in an ordinary OPEN statement. If the parameter is omitted, the routine
uses a value of zero, which has no effect.
open-mode
is a numeric operand that specifies the open mode attribute for the open operation. The
evaluation of this operand includes, if necessary, truncation to an integer value. If this parameter
is supplied, its value must be 0 (open mode is Input), 1 (I-O), 2 (Output), or 3 (Extend). If the
parameter is omitted, the routine uses a value of 0 (Input).
return-code
is an identifier of a numeric data item in which an error value will be returned. The expected
values and their respective meanings are:
MeaningValue
Successful execution0
file-name is missing or is invalid, or an extraneous parameter is present.1
The value of the open-type, exclusion, or sync-depth parameter is invalid.2
The device-type of the file specified is not compatible with the value specified for
open-type.
4
An operation error occurred (for example, the file could not be opened).5
When the COBOL85_SPECIAL_OPEN_ routine with an open-type of 3 has performed a successful
open operation, the special register GUARDIAN-ERR contains the value 3 (failure to open a partition)
if the operating environment reports that file code. In this case, the I-O status code is “00.”
ZCOBDLL Routines 643