COBOL Manual for TNS and TNS/R Programs

Libraries and Utility Routines
HP COBOL Manual for TNS and TNS/R Programs—522555-006
13-79
COBOL85^SPECIAL^OPEN and
COBOL_SPECIAL_OPEN_
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 system log file,
the routine uses a value of 1.
time-limits
is a numeric operand that specifies the TIME-LIMITS attribute for a system log file
only when the subdevice type is other than 0; if the subdevice type is 0, this
parameter is ignored. The evaluation of this operand includes, if necessary,
truncation to an integer value. If this parameter is present and its value is not zero,
LOCKFILE and READ statements that refer to the system log file can include the
TIME LIMIT wait-time phrase, indicating the maximum time a process waits for a
request to complete. If the parameter is omitted, the routine uses a value of zero.
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:
Usage Considerations:
•
Sending a Message to $0
To send an EMS event or ASCII text message to the EMS device ($0) or an
alternate collector, use the WRITE statement.
•
Sending an SPI command to $0.#ZSPI
To send an SPI command to the SPI device ($0.#ZSPI), use the READ statement
with a PROMPT phrase.
Value Meaning
0 Successful execution
1 file-name is missing or is invalid, or an extraneous parameter is present.
2 The value of the open-type, exclusion, or sync-depth parameter is
invalid.
4The device-type of the file specified is not compatible with the value
specified for open-type.
5 An operation error occurred (for example, the file could not be opened).