UIM Spooled File User-defined List Action Exit Program
Required Parameter Group:
1 | Exit point name | Input | Char(20) |
2 | Format | Input | Char(8) |
3 | User-defined action | Input | Char(1) |
4 | Spooled file identity | Input | Char(*) |
5 | Length of spooled file identity | Input | Binary(4) |
Exit Point Name: QIBM_QSP_SPLF_LSTACT
Exit Point Format Name: LASP0100
QSYSINC Member Name: espxpts
The UIM Spooled File User-defined List Action exit point can be used to define additional list actions on the following green screen interfaces:
- Work with Printer Output (WRKSPLF ASTLVL(*BASIC))
- Work with Spooled Files (WRKSPLF ASTLVL(*INTERMED))
- Work with Job Spooled Files (WRKJOB OPTION(*SPLF))
- Work with Output Queue (WRKOUTQ output queue name)
- Work with Spooled File Status (D P or WRKSPLF DSPFMT(*S36FMT))
An exit program that takes the user-defined list action and spooled file identity as input and performs the desired action must be registered to this exit point by using the Add Exit Program (QUSADDEP, QusAddExitProgram) API or the ADDEXITPGM command.
Authorities and Locks
None.
Required Parameters
- Exit point name
- INPUT; CHAR(20)
The name of the registered exit point. The value of this parameter will always be QIBM_QSP_SPLF_LSTACT.
- Format
- INPUT; CHAR(8)
The name of the format describing the spooled file identity information passed to the exit program. The value of this parameter will always be LASP0100.
- User-defined action
- INPUT; CHAR(1)
The user-defined action specified by the user on the UIM list panel.
- Spooled file identity
- INPUT; CHAR(*)
The identity of the spooled file on which the user-defined action is to be performed. The identity of the spooled file consists of the qualified job name, spooled file name, spooled file number, job system name, create date and time, output queue name and output queue library of the spooled file.
- Spooled file identity length
- INPUT; BINARY(4)
The length of the spooled file identity information in number of bytes.
LASP0100 Format
The following table shows the format of the LASP0100 structure for the Spooled file identity parameter. For more details about the fields in the following table, see Field Descriptions.
Offset | Type | Field | |
---|---|---|---|
Dec | Hex | ||
0 | 0 | CHAR(10) | Spooled file job name |
10 | A | CHAR(10) | Spooled file user name |
20 | 14 | CHAR(6) | Spooled file job number |
26 | 1A | CHAR(10) | Spooled file name |
36 | 24 | BINARY(4) | Spooled file number |
40 | 28 | CHAR(8) | Job system name |
48 | 30 | CHAR(7) | Spooled file create date |
55 | 37 | CHAR(6) | Spooled file create time |
61 | 3D | CHAR(10) | Output queue name |
71 | 47 | CHAR(10) | Output queue library name |
Field Descriptions
Job system name. The name of the system where the job that created this spooled file ran.
Output queue name. The name of the output queue where the spooled file is located.
Output queue library name. The name of the library that contains the output queue.
Spooled file create date. The date the spooled file was created on the system in the CYYMMDD format. See field Date file opened in API QUSRSPLA under field descriptions for more information on the date format.
Spooled file create time. The time the spooled file was created on the system in the HHMMSS format. See field Time file opened in API QUSRSPLA under field descriptions for more information on the time format.
Spooled file job name. The name of the job that owns the spooled file.
Spooled file job number. The job number of the job that owns the spooled file.
Spooled file name. The name of the spooled file being processed.
Spooled file number. The number of the spooled file being processed.
Spooled file user name. The user that owns the spooled file.
Exit program introduced: V6R1
[ Back to top | Print APIs | APIs by category ]