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

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 line printer (device type
5) or a spooler collector (device type 0, subdevice type 31).
open-type
is a numeric operand whose value (after truncation to an integer value, if necessary) is 1. The
value 1 (the default) signifies the opening of a line printer or a spooler collector.
exclusion
is a numeric operand that specifies the exclusion attribute for the open operation. The evaluation
of this operand includes truncation to an integer value if necessary. If exclusion 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 if one applies to the
specified FD-name; otherwise, it assumes the value 1 (exclusive).
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 line printer, the routine uses a value of 1; for a spooler collector,
it uses a value of 3.
no-eject
is a numeric operand that specifies whether a page ejection must precede the first record
delivered to the file. The evaluation of this operand includes, if necessary, truncation to an
integer value. A value of 0 requests that a page ejection be done; a nonzero value requests
that there be no initial ejection. If no value is specified, the routine uses a value of zero.
no-eject does not apply if file-name has LINAGE specified.
level-3
is a numeric operand that specifies whether level-2 or level-3 spooling is to be used. The
evaluation of this operand includes, if necessary, truncation to an integer value. Any nonzero
value requests level-3 spooling; the value zero requests level-2 spooling. If no value is specified,
the routine uses a value of zero. This parameter applies only to spooler collectors.
location
is a 16-character alphanumeric, PIC X(16), that identifies the string passed to the spooler as
its location parameter. The data item must be at least 16 characters. If longer, only the first
16 characters are passed to the spooler. The spooler expects a two-part location name in the
format
#gggggggdddddddd
where #ggggggg is the group name and dddddddd is the destination name. The pound sign
(#) is required. All remaining characters can be letters, digits, or spaces.
The access mode (see Linkage Section (page 179)) of location must be STANDARD.
form-name
is an alphanumeric or equivalent data item that specifies the spooler job form name.
form-name must not:
• Start with a number or a space character
• Contain any special characters or embedded blanks
Any value provided is adjusted to a length of 16 characters (by extending with spaces or
truncating). If no value is specified, the routine uses a value of all spaces. This parameter
applies only to spooler collectors.
638 Libraries and Utility Routines