List Spooled Files (QUSLSPL) API
Required Parameter Group:
| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format name | Input | Char(8) |
| 3 | User name | Input | Char(10) |
| 4 | Qualified output queue name | Input | Char(20) |
| 5 | Form type | Input | Char(10) |
| 6 | User-specified data | Input | Char(10) |
Optional Parameter Group 1:
| 7 | Error Code | I/O | Char(*) |
Optional Parameter Group 2:
| 8 | Qualified job name | Input | Char(26) |
| 9 | Key for the fields to return | Input | Array(*) of Binary(4) |
| 10 | Number of fields to return | Input | Binary(4) |
Optional Parameter Group 3:
| 11 | Auxiliary storage pool | Input | Binary(4) |
Optional Parameter Group 4:
| 12 | Job system name | Input | Char(8) |
| 13 | Starting spooled file create date | Input | Char(7) |
| 14 | Starting spooled file create time | Input | Char(6) |
| 15 | Ending spooled file create date | Input | Char(7) |
| 16 | Ending spooled file create time | Input | Char(6) |
Optional Parameter Group 5:
| 17 | Auxiliary storage pool device name | Input | Char(10) |
Default Public Authority: *USE
Threadsafe: No
The List Spooled Files (QUSLSPL) API is similar to the Work with Spooled Files (WRKSPLF) command or the Work with Job (WRKJOB OPTION(*SPLF)) command. The API generates a list of spooled files on the system and places the list in a user space. The list can include some of the following:
- All spooled files
- Spooled files of specific users or all users
- Spooled files in a specified output queue or in all output queues
- Spooled files for all form types or the standard form type
- Spooled files that have any user-specified data values
- Spooled files generated by a specific job
- Spooled files stored in an auxiliary storage pool.
The generated list replaces any existing information in the user space.
Authorities and Locks
- User Space Authority
- *CHANGE
- Library Authority
- *EXECUTE
- User Space Lock
- *EXCLRD
Output Queue Authority
The requester is authorized to the output queue if one or more of the following conditions are met:
- The requester has *SPLCTL authority.
- The requester has *JOBCTL authority, and the output queue is specified as OPRCTL(*YES).
- The requester has *READ authority to the output queue.
Required Parameter Group
- Qualified user space name
- INPUT; CHAR(20)
The user space that receives the generated list, and the library in which it is located. The first 10 characters contain the user space name, and the second 10 characters contain the library name.
You can use these special values for the library name:
*CURLIB The job's current library *LIBL The library list
- Format name
- INPUT; CHAR(8)
The format of the spooled file information being returned. You must specify the following:
SPLF0100 Contains the internal identifiers for the spooled file and the job that owns the spooled file. SPLF0200 Information that is shown when the list of the spooled files selected is displayed with the Work with Spooled Files (WRKSPLF) command. SPLF0300 Contains the basic information for the spooled file. Entries returned are taken directly from internal indexes and are not validated against existing spooled file and job structures. Retrieving a list of spooled files using this format is faster than using format SPLF0100 or SPLF0200. SPLF0400 Contains the basic information for the spooled file. This format differs from format SPLF0300 in that it provides dates and times in Coordinated Universal time (UTC) instead of local job time. Entries returned are taken directly from internal indexes and are not validated against existing spooled file and job structures. Retrieving a list of spooled files using this format is faster than using format SPLF0100 or SPLF0200.
- User name
- INPUT; CHAR(10)
The name of the user whose spooled files are included in the list. This parameter can be used in conjunction with the output queue and library name, form type, user-specified data, auxiliary storage pool, job system name, starting spooled file create date, starting spooled file create time, ending spooled file create date, and ending spooled file create timeparameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. It must be blank if the qualified job name parameter is specified.
A value must be specified if the qualified job name parameter is blank or not specified. Otherwise, message CPF34C6 or CPD34C6 is issued.
The possible special values are:
*ALL Files owned by all users *CURRENT Files owned by the current user
- Qualified output queue name
- INPUT; CHAR(20)
The name of the output queue whose files are to be included in the list, and the library in which it is located. The first 10 characters contain the output queue name, and the second 10 characters contain the library name. This parameter can be used in conjunction with the user name, form type, user-specified data, auxiliary storage pool, job system name, starting spooled file create date, starting spooled file create time, ending spooled file create date, and ending spooled file create time parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. It must be blank if the qualified job name parameter is specified.
Note: A value must be specified if the qualified job name parameter is blank or not specified. Otherwise, message CPF34C6 or CPD34C6 is issued.
You can use this special value for the output queue name:
*ALL Files on all output queues. When you use this value, the library name must be blanks. Output queue name The name of the output queue.
You can use these special values for the library name:
*CURLIB The job's current library *LIBL The library list
- Form type
- INPUT; CHAR(10)
The form type whose files are included in the list. The form type is the value specified on the form type parameter of the printer file. This parameter can be used in conjunction with the user name, qualified output queue name, user-specified data, auxiliary storage pool, job system name, starting spooled file create date, starting spooled file create time, ending spooled file create date, and ending spooled file create time parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. It must be blank if the qualified job name parameter is specified.
The special values supported are:
*ALL Files for all form types *STD Only files that specify the standard form type
- User-specified data
- INPUT; CHAR(10)
The user-specified data value whose files are to be included in the list. This parameter can be used in conjunction with the user name, qualified output queue name, form type, auxiliary storage pool, job system name, starting spooled file create date, starting spooled file create time, ending spooled file create date, and ending spooled file create time parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. It must be blank if the qualified job name parameter is specified.
The special value supported is:
*ALL Files with any user-specified data values
Optional Parameter Group 1
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.
Optional Parameter Group 2
- Qualified job name
- INPUT; CHAR(26)
The qualified job name of the job whose spooled files are to be included in the list. If the user name, the qualified output queue name, the form type, user-specified data, or auxiliary storage pool is specified, this parameter must be blank. Otherwise, message CPF34C2 is issued. The list of spooled files returned is sorted by spooled file number.
The qualified job name has three parts:
job name CHAR(10). A specific job name, or the following special value:
* Current running job. The rest of the qualified job name parameter must be blank.
user name CHAR(10). A specific user profile name, or blank when 
either the job name is
asterisk (*), or the user profile name is not needed to uniquely
identify the job.
job number CHAR(6). A specific job number, or blank when either the
job name is asterisk (*), or the job number is not needed to uniquely
identify the job.If this parameter is omitted, the API assumes all blanks.
- Keys for the fields to return
- INPUT; ARRAY(*) of BINARY(4)
The list of the fields to be returned in the SPLF0200 format. By specifying a set of keys, only the fields whose keys are specified are in the returned format. See Valid Keys for a list of valid keys. This field is only used for the SPLF0200 format. This field is ignored if the number of keys for fields to return parameter is 0.
- Number of fields to return
- INPUT; BINARY(4)
The number of fields to return in the SPLF0200 format. This indicates how many keys are in the array of the keys for the fields to return parameter. This field is used for the SPLF0200 format only, and it must be 0 when the SPLF0100, SPLF0300, or SPLF0400 format is specified.
If this parameter is omitted, the API assumes 0.
Optional Parameter Group 3
- Auxiliary storage pool (ASP)
- INPUT; BINARY(4)
The auxiliary storage pool whose spooled files are to be included in the list. This parameter can be used in conjunction with the user name, qualified output queue name, form type, user-specified data, job system name, starting spooled file create date, starting spooled file create time, ending spooled file create date, and ending spooled file create time parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. It must be blank if the qualified job name parameter is specified.
The valid values are:
-1 *BLANK. No auxiliary storage pool is specified. 0 *ALL. Spooled files in all auxiliary storage pools as specified in the Auxiliary storage pool device name parameter. 1 *SYSTEM. Spooled files in the system auxiliary storage pool. -2 *ASPDEV. Spooled files in the auxiliary storage pool device specified on the Auxiliary storage pool device name parameter. 2-255 User auxiliary storage pool (2-32), or a primary or a secondary auxiliary storage pool (33-255). If this parameter is omitted, the API assumes 0 when the qualified job name parameter is blank or not specified. The API assumes -1 if the qualified job name parameter is not blank.
Optional Parameter Group 4
- Job system name
- INPUT; Char(8)
The name of the system where the job, specified in the qualified job name parameter, was run. This parameter can be used in conjunction with the user name, qualified output queue name, form type, user-specified data, auxiliary storage pool, starting spooled file create date, starting spooled file create time, ending spooled file create date, ending spooled file create time, or qualified job name parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time.
The following special values are supported for this parameter:
*ALL The returned list is not to be filtered based on job system name. *CURRENT Only spooled files created on the current system are to be returned. job-system-name Only spooled files created on the system specified are to be returned. If this parameter is omitted, the API assumes *ALL.
- Starting spooled file create date
- INPUT; Char(7)
The date, based on local job time, that the spooled file was created on the system. This parameter can be used in conjunction with the user name, qualified output queue name, form type, user-specified data, auxiliary storage pool, job system name, starting spooled file create time, ending spooled file create date, ending spooled file create time, or qualified job name parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. The date must be in the CYYMMDD format or one of the following special values:
*ALL The returned list is not to be filtered based on spooled file create date and spooled file create time. *FIRST All spooled files starting with the earliest create date and time and less than or equal to the ending spooled file create date and time are to be returned. date All spooled files with a create date and time equal to or later than the starting spooled file create date and time and less than or equal to the ending spooled file create date and time are to be returned.
The date format CYYMMDD is defined as follows:
C Century, where 0 indicates years 19xx and 1 indicates years 20xx. YY Year MM Month DD Day
- Starting spooled file create time
- INPUT; Char(6)
The time, in local job time, that the spooled file was created on the system. This parameter can be used in conjunction with the user name, qualified output queue name, form type, user-specified data, auxiliary storage pool, job system name, starting spooled file create date, ending spooled file create date, ending spooled file create time, or qualified job name parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. This parameter must be set to blanks when special value *ALL or *FIRST is used for parameter Starting spooled file create date. This parameter must have a value set if a date is specified for parameter Starting spooled file create date. The time must be in the HHMMSS format.
The time format HHMMSS is defined as follows:
HH Hour MM Minutes SS Seconds
- Ending spooled file create date
- INPUT; Char(7)
The date, based on local job time, that the spooled file was created on the system. This parameter can be used in conjunction with the user name, qualified output queue name, form type, user-specified data, auxiliary storage pool, job system name, starting spooled file create date, starting spooled file create time, ending spooled file create time, or qualified job name parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. If the Starting spooled file create date parameter is set to *ALL, then this parameter must be set to blanks. If a date has been specified for the Starting spooled file create date parameter, then this parameter must be set to a valid date. The date must be in the CYYMMDD format or one of the following special values:
*LAST All spooled files with a create date and time equal to or later than the starting spooled file create date and time and equal to the last spooled file create date and time are to be returned. date All spooled files with a create date and time equal to or later than the starting spooled file create date and time and less than or equal to the ending spooled file create date and time are to be returned.
The date format CYYMMDD is defined as follows:
C Century, where 0 indicates years 19xx and 1 indicates years 20xx. YY Year MM Month DD Day
- Ending spooled file create time
- INPUT; Char(6)
The time, in local job time, that the spooled file was created on the system. This parameter can be used in conjunction with the user name, qualified output queue name, form type, user-specified data, auxiliary storage pool, job system name, starting spooled file create date, starting spooled file create time, ending spooled file create date, or qualified job name parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. This parameter must be set to blanks when special value *ALL is used for parameter Starting spooled file create date or when special value *LAST is used for parameter Ending spooled file create date. This parameter must have a value set if a date is specified for parameter Ending spooled file create date. The time must be in the HHMMSS format.
The time format HHMMSS is defined as follows:
HH Hour MM Minutes SS Seconds
Optional Parameter Group 5
- Auxiliary storage pool (ASP) device name
- INPUT; Char(10)
The auxiliary storage pool device name from which spooled files are to be included in the list. When 0 or -2 is specified on the Auxiliary storage pool parameter, this parameter can be used in conjunction with the user name, qualified output queue name, form type, user-specified data, job system name, starting spooled file create date, starting spooled file create time, ending spooled file create date, and ending spooled file create time parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time.
The valid values are:
* Files which are found in the ASPs that are currently part of the thread's library name space are returned. This includes the system ASP (ASP 1), all defined basic user ASPs (ASPs 2-32), and if the thread has an ASP group, the primary and secondary ASPs in the thread's ASP group. *CURASPGRP Files which are found in the primary and secondary ASPs in the thread's ASP group are selected. If no ASP group is associated with the thread, an error will be issued. *SYSBAS Files which are found in the system ASP (ASP 1) and all defined basic user ASPs (ASPs 2-32) are selected. auxiliary storage pool device name Files which are found in the specified primary or secondary ASP are selected. Only primary or secondary ASPs which are in the thread's ASP group may be specified. If no ASP group is associated with the thread, an error will be issued. If this parameter is omitted, the API assumes *. When the Qualified job name parameter is specified, all spooled files for the job that are found in the ASPs that are currently part of the caller's library name space are returned.
Format of the Generated List
The spooled file list consists of:
- A user area
- A generic header
- An input parameter section
- A header section
- A list data section
For details about the user area and generic header fields, see User spaces. For details about the remaining items, see the following subtopics. For descriptions of the fields in the list, see Field Descriptions.
When you retrieve list entry information from a user space, you must use the
entry size returned in the generic header as a displacement to the next list
entry. The size of each entry may be padded at the end. If you do not use the
entry size, the result may not be valid.
Input Parameter Section (Optional Parameter Groups 1 and 2)
Note: This input parameter section format is used only when Optional Parameter Group 1 or Optional Parameter Group 2 is specified on the call to the QUSLSPL API. The order of the fields in the input parameter section does not match the order of the parameters on the call to the API.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name specified |
| 10 | A | CHAR(10) | User space library name specified |
| 20 | 14 | CHAR(8) | Format name |
| 28 | 1C | CHAR(10) | User name specified |
| 38 | 26 | CHAR(10) | Output queue name specified |
| 48 | 30 | CHAR(10) | Output queue library name specified |
| 58 | 3A | CHAR(10) | Form type |
| 68 | 44 | CHAR(10) | User-specified data |
| 78 | 4E | CHAR(26) | Qualified job name specified |
| 104 | 68 | BINARY(4) | Number of key fields specified |
| 108 | 6C | ARRAY(*) of BINARY(4) | Key fields specified |
Input Parameter Section 2 (Optional Parameter Group 3, 4, and 5)
Note: This input parameter section format is used only when Optional Parameter Group 3, 4, or 5 is specified on the call to the QUSLSPL API. This input parameter section is used if optional parameter group 3, 4, or 5 is specified on the call to the API. The order of the fields in the input parameter section does not match the order of the parameters on the call to the API.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name specified |
| 10 | A | CHAR(10) | User space library name specified |
| 20 | 14 | CHAR(8) | Format name |
| 28 | 1C | CHAR(10) | User name specified |
| 38 | 26 | CHAR(10) | Output queue name specified |
| 48 | 30 | CHAR(10) | Output queue library name specified |
| 58 | 3A | CHAR(10) | Form type |
| 68 | 44 | CHAR(10) | User-specified data |
| 78 | 4E | CHAR(26) | Qualified job name specified |
| 104 | 68 | BINARY(4) | Offset to key fields specified |
| 108 | 6C | BINARY(4) | Number of key fields specified |
| 112 | 70 | BINARY(4) | Auxiliary storage pool specified |
| 116 | 74 | CHAR(8) | Job system name specified |
| 124 | 7C | CHAR(7) | Starting spooled file create date specified |
| 131 | 83 | CHAR(6) | Starting spooled file create time specified |
| 137 | 89 | CHAR(7) | Ending spooled file create date specified |
| 144 | 90 | CHAR(6) | Ending spooled file create time specified |
| 150 | 96 | CHAR(10) | Auxiliary storage pool device name specified |
| ARRAY(*) of BINARY(4) | Key fields specified | ||
Header Section
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User name |
| 10 | A | CHAR(10) | Output queue name |
| 20 | 14 | CHAR(10) | Output queue library name |
| 30 | 1E | CHAR(10) | User space name |
| 40 | 28 | CHAR(10) | User space library name |
| 50 | 32 | CHAR(26) | Qualified job name |
| 76 | 4C | CHAR(8) | Qualified job system name |
| 84 | 54 | CHAR(7) | Starting spooled file create date used |
| 91 | 5B | CHAR(6) | Starting spooled file create time used |
| 97 | 61 | CHAR(7) | Ending spooled file create date used |
| 104 | 68 | CHAR(6) | Ending spooled file create time used |
Format SPLF0100
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User name |
| 10 | A | CHAR(10) | Output queue name |
| 20 | 14 | CHAR(10) | Output queue library name |
| 30 | 1E | CHAR(10) | Form type |
| 40 | 28 | CHAR(10) | User-specified data |
| 50 | 32 | CHAR(16) | Internal job identifier |
| 66 | 42 | CHAR(16) | Internal spooled file identifier |
| 82 | 52 | CHAR(2) | Reserved |
| 84 | 54 | BINARY(4) | Auxiliary storage pool |
Format SPLF0200
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of fields returned |
| Offsets vary. These fields repeat, in the order listed, for each key field selected. | BINARY(4) | Length of field information returned | |
| BINARY(4) | Key field for field returned | ||
| CHAR(1) | Type of data | ||
| CHAR(3) | Reserved | ||
| BINARY(4) | Length of data returned | ||
| CHAR(*) | Data | ||
| CHAR(*) | Reserved | ||
Valid Keys
| Key | Type | Field |
|---|---|---|
| 201 | CHAR(10) | Spooled file name |
| 202 | CHAR(10) | Job name |
| 203 | CHAR(10) | User name |
| 204 | CHAR(6) | Job number |
| 205 | BINARY(4) | Spooled file number |
| 206 | CHAR(10) | Output queue name |
| 207 | CHAR(10) | Output queue library name |
| 208 | CHAR(10) | Device |
| 209 | CHAR(10) | User-specified data |
| 210 | CHAR(10) | Status |
| 211 | BINARY(4) | Total pages |
| 212 | BINARY(4) | Current page |
| 213 | BINARY(4) | Copies left to produce |
| 214 | CHAR(10) | Form type |
| 215 | CHAR(2) | Priority |
| 216 | CHAR(7) | Date file was opened (created) |
| 217 | CHAR(6) | Time file was opened (created) |
| 218 | CHAR(16) | Internal job identifier |
| 219 | CHAR(16) | Internal spooled file identifier |
| 220 | CHAR(10) | Device type |
| 221 | CHAR(7) | Date file last used |
| 222 | BINARY(4) | Spooled file size multiplier |
| 223 | BINARY(4) | Size of spooled file |
| 224 | BINARY(4) | Auxiliary storage pool |
| 225 | CHAR(8) | Job system name |
| 226 | CHAR(10) | Auxiliary storage pool device name |
| 227 | CHAR(7) | Date file was created in UTC |
| 228 | CHAR(6) | Time file was created in UTC |
Format SPLF0300
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name |
| 10 | A | CHAR(10) | User name |
| 20 | 14 | CHAR(6) | Job number |
| 26 | 1A | CHAR(10) | Spooled file name |
| 36 | 24 | BINARY(4) | Spooled file number |
| 40 | 28 | BINARY(4) | Spooled file status |
| 44 | 2C | CHAR(7) | Date file was opened (created) |
| 51 | 33 | CHAR(6) | Time file was opened (created) |
| 57 | 39 | CHAR(1) | Spooled file schedule |
| 58 | 3A | CHAR(10) | Spooled file system name |
| 68 | 44 | CHAR(10) | User-specified data |
| 78 | 4E | CHAR(10) | Form type |
| 88 | 58 | CHAR(10) | Output queue name |
| 98 | 62 | CHAR(10) | Output queue library name |
| 108 | 6C | BINARY(4) | Auxiliary storage pool |
| 112 | 70 | BINARY(4) | Size of spooled file |
| 116 | 74 | BINARY(4) | Spooled file size multiplier |
| 120 | 78 | BINARY(4) | Total pages |
| 124 | 7C | BINARY(4) | Copies left to produce |
| 128 | 80 | CHAR(1) | Priority |
| 129 | 81 | CHAR(3) | Reserved |
| 132 | 84 | BINARY(4) | Internet print protocol job identifier |
Format SPLF0400
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name |
| 10 | A | CHAR(10) | User name |
| 20 | 14 | CHAR(6) | Job number |
| 26 | 1A | CHAR(10) | Spooled file name |
| 36 | 24 | BINARY(4) | Spooled file number |
| 40 | 28 | BINARY(4) | Spooled file status |
| 44 | 2C | CHAR(7) | Date file was created in UTC |
| 51 | 33 | CHAR(6) | Time file was created in UTC |
| 57 | 39 | CHAR(1) | Spooled file schedule |
| 58 | 3A | CHAR(10) | Spooled file system name |
| 68 | 44 | CHAR(10) | User-specified data |
| 78 | 4E | CHAR(10) | Form type |
| 88 | 58 | CHAR(10) | Output queue name |
| 98 | 62 | CHAR(10) | Output queue library name |
| 108 | 6C | BINARY(4) | Auxiliary storage pool |
| 112 | 70 | BINARY(4) | Size of spooled file |
| 116 | 74 | BINARY(4) | Spooled file size multiplier |
| 120 | 78 | BINARY(4) | Total pages |
| 124 | 7C | BINARY(4) | Copies left to produce |
| 128 | 80 | CHAR(1) | Priority |
| 129 | 81 | CHAR(3) | Reserved |
| 132 | 84 | BINARY(4) | Internet print protocol job identifier |
Field Descriptions
Auxiliary storage pool. The auxiliary storage pool in which the spooled file resides.
Valid values are:
| 1 | *SYSTEM. System auxiliary storage pool |
| 2-255 | The number of the auxiliary storage pool. |
Auxiliary storage pool device name. The name of the auxiliary storage pool device in which the spooled file resides.
Valid values are:
| *SYSBAS | The spooled file resides in the system ASP (ASP 1) or one of the defined basic user ASPs (ASPs 2-32). |
| auxiliary storage pool device name | The name of the auxiliary storage pool device in which the spooled file resides. |
Auxiliary storage pool device name specified. The auxiliary storage pool device name specified in the call to the API.
Auxiliary storage pool specified. The auxiliary storage pool specified in the call to the API.
Copies left to produce. The remaining number of copies to be produced on the writer. This attribute applies to printer device type spooled files only.
Current page. The page number or record number currently being written. The page number may be lower or higher than the page number actually being printed because of buffering done by the system. For example, if the spooled file is routed to a diskette unit or the writer is currently printing job separators or file separators for the spooled file, the page number shown may be zero.
Data. The data returned for the key field.
Date file last used. The date, based on local job time, that the file was last used in the CYYMMDD format.
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
Date file was created in UTC. The date, based on Coordinated Universal Time (UTC), that the file was opened in the CYYMMDD format.
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
Date file was opened (created). The date, based on local job time, that the file was opened in the CYYMMDD format.
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
Device. The name of the device on which the spooled file is located. If the spooled file is on an output queue that is the default output queue of a printer, this field contains the name of the output queue. Otherwise, this field is blank.
Device type. The type of device for which the spooled file is intended. The possible values are PRINTER or DISKETTE.
Ending spooled file create date specified. The spooled file create date specified in the call to the API.
Ending spooled file create date used. The spooled file create date used by the API to generate the list of spooled files.
Ending spooled file create time specified. The spooled file create time specified in the call to the API.
Ending spooled file create time used. The spooled file create time used by the API to generate the list of spooled files.
Form type. The type of form to load in the printer to print this file. This attribute applies to printer device type spooled files only.
Format name. The format of the retrieved output.
Job name. The name of the job that owns the spooled file.
Job number. The number of the job that owns the spooled file.
Job system name. The name of the system where the job that created the spooled file ran.
Job system name specified. The name of the system where the qualified job, specified in the call to the API, was run.
Key field for field returned. The identifier of the field returned. See Valid Keys for a list of valid keys. The fields in the list data section are returned in the order specified by the key fields specified parameter for each spooled file in the list.
Key fields specified. The list of fields to return in the SPLF0200 format specified in the call to the API.
Internal job identifier. The internal identifier for the job. Only the IBM® i APIs use this identifier, not any other interface on the system. The identifier is not valid following an initial program load (IPL). If you attempt to use it after an IPL, an exception occurs. This identifier is always valid when used with the internal spooled file identifier as input to IBM i APIs. For spooled files which have been detached from their jobs or which are on independent disk pools, this value is not valid as input to some IBM i APIs, such as the Retrieve Job Information (QUSRJOBI) API, that take this value without the internal spooled file identifier.
Internal spooled file identifier. The input value that other programs use to improve the performance of locating the spooled file on the system. Only the spooled file APIs use this identifier, not any other interface on the system. The identifier is not valid following an initial program load (IPL) or if the spooled file has been moved between auxiliary storage pools (ASPs). If you attempt to use an invalid internal spooled file identifier, an exception occurs.
Internet print protocol job identifier. The IPP job identifier assigned by the system based on the output queue to which the file was added or moved. This value ranges from 1 to 2147483647 and is not guaranteed to be unique for a given output queue.
Length of data returned. The length of the data returned for the field.
Length of field information returned. The total length of information returned for this field.
Number of fields returned. This is the number of fields returned to the application.
Number of key fields specified. The number of fields to return in format SPLF0200 specified in the call to the API.
Offset to key fields specified. The offset to the keys of the fields to be returned that is specified in the call to the API.
Output queue library name specified. The name of the output queue library specified in the call to the API.
Output queue library name. The library where the output queue is located.
Output queue name specified. The name of the output queue specified in the call to the API.
Output queue name. The name of the output queue in which the file is located.
Priority. The priority of the spooled file. The priority ranges from 1 (highest) to 9 (lowest).
Qualified job name specified. The qualified name of the job specified in the call to the API.
Qualified job name. The qualified name of the job that owns the spooled files.
Qualified job system name. The name of the system the qualified job was run on.
Reserved. The field is reserved.
Size of spooled file. The spooled file size. Multiply this field by the spooled file size multiplier field to get the size of the spooled file in number of bytes. The spooled file size is the data stream size plus the "overhead" storage used to store the spooled file's data stream, which includes the spooled file's attributes.
Spooled file name. The name of the spooled file in the list entry.
Spooled file number. The number of the spooled file in the list entry.
Spooled file schedule. The schedule of the spooled file.
Valid values are:
| 1 | The spooled file is schedule immediate. A spooling writer can process the spooled file immediately. |
| 2 | The spooled file is schedule file end. A spooling writer cannot process the spooled file until it has been closed. |
| 3 | The spooled file is schedule job end. A spooling writer cannot process the spooled file until the job of the spooled file has ended. |
Spooled file size multiplier. This value must be multiplied by the size of spooled file field to get the size of the spooled file in number of bytes.
Spooled file status. The status of the file. The following list of values is used to describe the status of the file:
| 1 | RDY The file is available to be written to an output device by a writer. |
| 2 | OPN The file has not been processed completely and is not ready to be selected by a writer. |
| 3 | CLO The file has been processed completely by a program, but SCHEDULE(*JOBEND) was specified. The job that produced the spooled file has not finished. |
| 4 | SAV The file has been written and then saved. This file remains saved until it is released. |
| 5 | WTR This file currently is being produced by the writer on an output device. |
| 6 | HLD The file has been held. |
| 7 | MSGW This file has a message that needs a reply or needs an action to be taken. |
| 8 | PND This file is pending (waiting) to be printed. |
| 9 | PRT The file has been sent to the printer completely, but the print complete status has not been sent back. |
| 10 | FIN This spooled file is no longer in the system. These spooled files are included in the list of spooled files only if the qualified job name is specified. |
| 11 | SND This spooled file is being sent or has been sent to a remote system. |
| 12 | DFR This spooled file has been deferred from printing. |
Spooled file system name. The name of the system where the job that created the spooled file ran.
Starting spooled file create date specified. The spooled file create date specified in the call to the API.
Starting spooled file create date used. The spooled file create date used by the API to generate the list of spooled files.
Starting spooled file create time specified. The spooled file create time specified in the call to the API.
Starting spooled file create time used. The spooled file create time used by the API to generate the list of spooled files.
Status. The status of the file. The following list of values is used to describe the status of the file:
| *CLOSED | The file has been completely processed by a program, but SCHEDULE(*JOBEND) was specified. The job that produced the spooled file has not finished. |
| *DEFERRED | This spooled file has been deferred from printing. |
| *SENDING | This spooled file is being sent or has been sent to a remote system. |
| *FINISHED | This spooled file is no longer in the system. These spooled files are included in the list of spooled files only if the qualified job name is specified. |
| *HELD | The file has been held. |
| *MESSAGE | This file has a message that needs a reply or needs an action to be taken. |
| *OPEN | The file has not been completely processed and is not ready to be selected by a writer. |
| *PENDING | This file is pending (waiting) to be printed. |
| *PRINTER | The file has been completely sent to the printer, but the print complete status has not been sent back. |
| *READY | The file is available to be written to an output device by a writer. |
| *SAVED | The file has been written and then saved. This file remains saved until it is released. |
| *WRITING | This file is currently being produced by the writer on an output device. |
Time file was created in UTC. The time, in Coordinated Universal Time (UTC), that the file was opened in the HHMMSS format.
| HH | Hour |
| MM | Minute |
| SS | Second |
Time file was opened (created). The time, in local job time, that the file was opened in the HHMMSS format.
| HH | Hour |
| MM | Minute |
| SS | Second |
Total pages. The number of pages this printer file contains or the number of records this diskette file contains.
Type of data. The type of data returned.
| C | The data is returned in character format. |
| B | The data is returned in binary format |
User name. The name of the user that owns the spooled file.
User name specified. The name of the user specified in the call to the API.
User space library name. The library containing the user space.
User space library name specified. The library name of the user space specified.
User space name. The name of the user space that contains the format returned.
User space name specified. The name of the user space specified.
User-specified data. The 10 characters of user-specified data that describe the file.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C20 E | Error found by program &1. |
| CPD3C21 D | Format name &1 is not valid. |
| CPD3C30 D | Library name &1 is not valid for output queue *ALL. |
| CPD34C6 D | Too few selection criteria specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C30 E | Library name &1 is not valid for output queue *ALL. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF33FA E | Auxiliary storage pool specified is not valid. |
| CPF3330 E | Necessary resource not available. |
| CPF3336 E | Job &5/&4/&3 no longer in the system. |
| CPF3342 E | Job &5/&4/&3 not found. |
| CPF3343 E | Duplicate job names found. |
| CPF3350 E | Job &5/&4/&3 no longer in the system. |
| CPF335D E | Job system name is not valid. |
| CPF335E E | Starting spooled file create date is not valid. |
| CPF335F E | Starting spooled file create time is not valid. |
| CPF336C E | Starting spooled file create time is not blank. |
| CPF336D E | Ending spooled file create date is not valid. |
| CPF336E E | Ending spooled file create date is not blank. |
| CPF336F E | Ending spooled file create time is not valid. |
| CPF337A E | Ending spooled file create time is not blank. |
| CPF337E E | ASP device &1 not in current ASP group for thread. |
| CPF338B E | ASP device &1 not allowed with ASP number &2. |
| CPF34C1 E | Value &1 in keys for fields to return parameter not valid. |
| CPF34C2 E | Too many selection criteria specified. |
| CPF34C4 E | List is too large for user space &1. |
| CPF34C6 E | Too few selection criteria specified. |
| CPF811A E | User space &4 in &9 damaged. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9807 E | One or more libraries in library list deleted. |
| CPF9808 E | Cannot allocate one or more libraries on library list. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9830 E | Cannot assign library &1. |
| CPF9833 E | *CURASPGRP or *ASPGRPPRI specified and thread has no ASP group. |
| CPF9838 E | User profile storage limit exceeded. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API Introduced: V1R3
[ Back to top | Print APIs | APIs by category ]