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

code-129
is a numeric operand that specifies whether a code 129 file (spooler job file) is to be created
or a regular spooler file is to be created. A nonzero value indicates that the run-time library is
to call SPOOLSTART with file-name reflecting the name specified in the ASSIGN phrase of
the SELECT clause for the file or by an ASSIGN TACL command. See the description of
SPOOLSTART in the Guardian Procedure Calls Reference Manual for details on spooler job
files. The resulting file must be a disk file and must be a code 129 spooler job file if it exists.
If the actual file is incorrect, an error is reported and the program terminates abnormally. If the
value of code-129 is 0, it is assumed that the actual file assigned will be a normal spooler
process. You can use flags to control whether the file is compressed and whether old data
in the file is deleted or new data is appended. If code-129 is specified, these parameters are
ignored:
Value UsedParameter
Protectedexclusion
1sync-depth
Level 3level-3
The file specified in the SELECT clauselocation
form-feed
is a numeric operand that specifies whether a form feed (CONTROL (file, 1, 0)) is to be used
to position to the top of a new page rather than using spacing when LINAGE is specified for
the file. A value of 0 (the default) indicates that spacing is to be used; a nonzero value indicates
that a form feed is to be used. If form-feed is nonzero, the sizes of the pages may not conform
to that specified in the LINAGE clause for the file. The size depends on the forms control
mechanism of the printer.
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 value of the owner parameter is invalid.3
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
In the Guardian environment, all the functions of this form of COBOL_SPECIAL_OPEN_ except
those provided by the parameters no-eject, code-129, and form-feed can also be provided
by a DEFINE of class SPOOL, but COBOL_SPECIAL_OPEN_ brings the functionality into the
program, while the DEFINE solution leaves it out in the run-time environment.
A file assigned to a printer or to a spooler collector process (identified at run time by its subdevice
type of 31) is handled as a printer, in that calls to Guardian environment routines CONTROL and
SETMODE are used to initialize the file’s state, to suppress automatic forms skipping, and to handle
ADVANCING clauses, and the writing of a given record is deferred until the next record is ready
to be written (or the file is to be closed) to minimize the number of Guardian procedure calls
involved in writing.
640 Libraries and Utility Routines