COBOL Manual for TNS and TNS/R Programs

Libraries and Utility Routines
HP COBOL Manual for TNS and TNS/R Programs—522555-006
13-99
COBOLSPOOLOPEN
sync-depth
is a numeric item (COMPUTATIONAL or DISPLAY), a numeric literal, or a
parenthetical expression that evaluates to a positive integer, which is used as the
sync-depth of the spooler file. Its default value is 3. A value greater than 32 results
in a file-system error 28 from the spooler. The sync-depth specifies the number of
write requests whose completion status the file system is to remember.
owner
is an alphanumeric data item, PIC X(16), that specifies the owner of the spooler job
in this format:
gggggggguuuuuuuu
The value gggggggg is a file-security system group name, and uuuuuuuu is a
file-security system user name. Each of these names must be eight characters
long, with trailing spaces inserted if necessary. The item does not include a period
between the names.
If you specify an invalid combination of names for this parameter,
COBOLSPOOLOPEN returns error code 102.
If you omit the owner parameter, the spooler uses the owner ID of the executing
process.
level-3
is a numeric item (COMPUTATIONAL or DISPLAY), a numeric literal, or a
parenthesized expression. If its value is other than zero, the output to the spooler is
done using level-3 spooling, which enhances performance by sending records to
the spooler in blocks.
If you omit the level-3 parameter, or if it has a value of zero, the output records are
sent one at a time.
error-code
is a numeric data item, PIC 9(4) COMPUTATIONAL, that identifies the data item
into which COBOLSPOOLOPEN returns an error code value. USAGE DISPLAY is
permitted in place of USAGE COMPUTATIONAL; however, in this case the data
item’s PICTURE character-string should be 9(4), so it is capable of containing the
full range of potential values. The error code value returned for success is 0; a
nonzero value implies failure to open the file.
The access mode (see Linkage Section) of error-code must be STANDARD.
All the parameters except fd-name are optional. If a parameter is omitted, but one or
more following ones are present, its position in the USING phrase must be occupied by
the reserved word OMITTED (for details, see ENTER). Although the GIVING phrase is
optional, it is recommended for error analysis.