- overall_status
record by reference (required)
Returns the overall status of the call. A zero indicates a successful call. A negative value indicates an error in the overall call. A positive value indicates a warning. Refer to appendix A for meanings of status values.
Record type: status_type (Refer to appendix B.)
- spooler_device
record by reference (required)
Passes the logical device number (LDEV), device name, or device class for which the spooling process is to be suspended. An LDEV number must be converted into an ASCII character string before being passed to this routine. The name should be left-justified and padded with blanks.
Array type: device_name_type (Refer to appendix B.)
- finish
32-bit signed integer by reference (optional)
Passes the finishing strategy for suspending the spooling process.
The valid inputs and their meanings are as follows:
- 1
Finish now (default)
- 2
Finish at end of copy
Default: 1
- keep
32-bit signed integer by reference (optional)
Passes a value that tells the spooler whether to retain ownership of the currently printing spool file or to close the file and return it to the ready state. The valid inputs and their meanings are as follows:
- 1
Keep (default)
- 2
No keep
Do not pass both the finish end of copy and the Keep flags.
Also, do not pass finish-end-of-copy and pass a non-zero offset.
Default: 1
- direction
32-bit signed integer by value (optional)
Passes a value that tells the spooler how to apply the offset parameter. See also the explanation of the offset parameter for relative and absolute offsets.
- 0
Relative offset specified in the offset parameter (default)
- 1
Absolute offset specified in the offset parameter
Default: 0
- offset
32-bit signed integer by value (optional)
Passes an integer representing a page offset, either absolute or
relative, within the spool file. Together with the direction parameter, it tells the spooler where to resume when the file is picked up again for printing.
If "absolute" is specified in direction, printing resumes at that page, absolute from the beginning of the file. If "relative" is specified in direction, then depending on whether offset is positive or negative, the offset is adjusted either forward or backward relative to the current location, by the number of pages specified.
No matter which combination of offsets is specified, the final location is limited by the bounds of the file. The default for offset is 0. If the printing of a spool file is to be resumed from the beginning of the file, pass absolute for direction and 0 for offset.
Default: 0
- q_state
32-bit signed integer by reference (optional)
Passes a value that indicates whether the spooling queue is to
be opened or disabled when the spooling process is suspended.
The default is not to change the current q_state of the
spooler process. The valid inputs and their meanings are as follows:
- 0
No change to the current q_state of the spooling process (default)
- 1
Openq
- 2
Shutq
Default: 0
- user_id
32-bit signed integer by value (optional)
The user ID assigned to a vendor at the time of purchase of the Architected Interface Facility: Operating System product.
If it is not passed, the caller must have previously called
AIFACCESSON.
Default: 0
