Retrieve Spool Information (QSPSPLI) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Auxiliary storage pool (ASP) group name | Input | Char(10) |
| 5 | User name | Input | Char(10) |
| 6 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: Yes
The Retrieve Spool Information (QSPSPLI) API returns information about the spooling environment on the system such as the number of spooled files in an ASP group or the number of spooled files owned by a user.
Authorities and Locks
- Auxiliary Storage Pool (ASP) Device Authority
- *USE to all ASP devices in an ASP group when a specific
ASP group is specified for the ASP group parameter.
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the receiver variable. If the length is larger than the size of the receiver variable, the results are not predictable. The minimum length is 8 bytes.
- Format name
- INPUT; CHAR(8)
The format of the spool information being returned. The valid format is SPLI0100.
- Auxiliary storage pool (ASP) group name
- INPUT; CHAR(10)
The name of an auxiliary storage pool (ASP) group for which spool information is being requested. The status of the ASP group must be 'Available'. If this field is blank, the value *SYSBAS will be assumed. One of the following special values may be specified:
*SYSBAS The spool information for the system ASP (ASP 1) and defined basic user ASPs (ASPs 2-32) will be returned. *CURASPGRP The spool information for the ASPs in the current thread's ASP group will be returned. - User name
- INPUT; CHAR(10)
The name of the user who owns the spooled files to be considered when returning the requested spool information. One of the following special values may be specified:
*ALL Spooled files owned by all users *CURRENT Spooled files owned by the current user
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format of Receiver Variable
The following table describes the order and format of the data that is returned in the receiver variable.
SPLI0100 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Number of spooled files |
| 12 | C | CHAR(10) | Auxiliary storage pool (ASP) group name |
| 22 | 16 | CHAR(10) | User name |
Field Descriptions
Auxiliary storage pool (ASP) group name. The name of the auxiliary storage pool (ASP) group where the spooled files exist. This is the name of the primary ASP in an ASP group or the name of an ASP device description. The following special value can be returned:
| *SYSBAS | The spool information for the system ASP (ASP 1) and defined basic user ASPs (ASPs 2-32) was returned. |
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
Number of spooled files. The number of spooled files in the specified auxiliary storage pool (ASP) group for the user name specified.
User name. The name of the user that owns the spooled files. The following special value can be returned:
| *ALL | Spooled files owned by all users |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C20 E | Error found by program &1. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF338C E | Internal spool control file is not accessible. |
| CPF339A E | *CURASPGRP specified and thread has no ASP group. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF9814 E | Device &1 not found. |
| CPF9825 E | Not authorized to device &1. |
| CPF9833 E | *CURASPGRP or *ASPGRPPRI specified and thread has no ASP group. |
| CPFB8ED E | Device description &1 not correct for operation. |
API introduced: V6R1 with PTF
[ Back to top | Print APIs | APIs by category ]