|
|
|
Returns spooler process information.
Syntax
REC I32A @64A
AIFSPPGET ( overall_status, itemnum_array, item_array,
RECA REC I32
itemstatus_array, spooler_device, user_id );
Parameters
- 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, not
specific to any particular item. A positive value indicates the last
element in itemstatus_array, signaling an error condition. Refer to
appendix A for meanings of status values.
Record type: status_type (Refer to appendix B.)
- itemnum_array
- 32-bit signed integer array by reference (required)
An array of integers where each element is an item number indicating the
information to be returned to a data structure pointed to in the
corresponding element in item_array. If n item numbers
are being requested, element n+1 must be a zero to
indicate the end of the element list.
- item_array
- 64-bit address array by reference (required)
An array where each element is a 64-bit address pointing to a data
structure where information is returned. Information and its required
data type are defined by the item number passed in the corresponding
element in itemnum_array.
Array type: globalanyptr
- itemstatus_array
- record array by reference (required)
An array where each element returns the status of the operation
performed in the corresponding element in item_array. A zero indicates a
successful operation. A negative value indicates an error condition. A
positive value indicates a warning. Refer to appendix A for meanings of
status values.
Array type: status_type (Refer to appendix B.)
- spooler_device
- record by reference (required)
Passes the device name or logical device number (LDEV) of the device
owned by a spooler process for which information is desired. A logical
device number (LDEV) 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.)
- 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
Operation Notes
When the spooler on a device is stopped, the spooler process entry will be
deallocated and no longer available for any access. Any reference to that
spooler process will return error -8003: The device is not spooled.
AIFSPPGET Items
The following two tables provide summary and detailed descriptions of the item
numbers associated with spooler process information.
Item Summary
The following table summarizes the item numbers associated with spooler
process information. For more detailed information about these item numbers,
refer to the tables of AIFSPPGET and AIFSPPPUT spooler
process information item descriptions.
Table 3-34 Spooler Process Information Item Summary
| Item |
Type |
Description |
Put |
Ver |
Min |
Max |
Error# |
| 8001 |
I32 | LDEV Number |
N | Y | | | |
| 8002 |
I32 | Process PIN |
N | Y | | | |
| 8003 |
I32 | Current spool file ID |
N | Y | | | |
| 8004 |
I32 | Process kind |
N | Y | | | |
| 8005 |
I32 | Process state |
N | Y | | | |
| 8006 |
I32 | Finish strategy |
N | Y | | | |
| 8009 |
I32 | Device outfence |
Y | Y | 0 | 14 | |
| 8010 |
I32 | Suspend keep flag |
N | Y | | | |
Item Descriptions
The following table provides detailed descriptions of item numbers and
corresponding items associated with spooler process information returned by
AIFSPPGET.
Table 3-35 AIFSPPGET Spooler Process Information Item Descriptions
| Item Number |
Item Name (Data Type) Release First Available
Description |
| 8001 |
LDEV number (I32) Release 3.0
Returns the LDEV number of the specified device. |
| 8002 |
Process PIN (I32) Release 3.0
Returns the process identification number (PIN) of the spooler process for
the specified device. |
| 8003 |
Current spool file ID (REC) Release 3.0
Returns the spool file ID of the spool file that is currently being
printed on the device.
Record type: spf_id_type (Refer to appendix B.) |
| 8004 |
Process kind (I32) Release 3.0
Returns the process kind of the spooler. Values and their meanings are as
follows:
| 0 | NoSpool |
| 1 | InSpool |
| 2 | OutSpool |
| 3 | (reserved) |
| 4 | (reserved) |
|
| 8005 |
Process state (I32) Release 3.0
Returns the state of the spooler process. Values and their corresponding
states are as follows:
| 0 | Initialization |
| 1 | Release |
| 2 | Start |
| 3 | Stop |
| 4 | Stop_Pending |
| 5 | Suspend |
| 6 | Suspend_Pending |
| 7 | Resume |
| 8 | Active |
| 9 | Shut_Pending |
| 10 | Idle |
|
| 8006 |
Finishing strategy (I32) Release 3.0
Returns the finishing strategy of the device. This is one of the options
that can be specified for the SPOOLERnn;STOP/SUSPEND
command. It is only valid when the spooler process is being suspended or
stopped. Values and their meanings are as follows:
| 0 | None (device not being suspended/stopped) |
| 1 | Now |
| 2 | End of copy |
|
| 8009 |
Device outfence (I32) Release 3.0
Returns the current outfence of the device, a value in the range
0..14. |
| 8010 |
Suspend keep flag (I32) Release 3.0
Returns a value indicating whether the spooler is to retain ownership of
the spool file or to close the spool file and return it to the
READY state. This is one of the options that can be specified for
the SPOOLERnn; SUSPEND command. The field is valid only
when the spooler process is being suspended. Values and their meanings are
as follows:
| 0 | None (suspend not currently in effect) |
| 1 | Keep |
| 2 | No keep |
|
|