Exit point QIBM_QNPS_SPLF is used by exit programs that process spooled files. The called exit program is passed four parameters. These parameters are pointers to structures in user domain storage. These structures, collectively, comprise format SPLF0100.
Required parameters
Required parameter group
1 Return code Output CHAR(1) 2 Server information Input CHAR(32) 3 Spooled file ID Input CHAR(40) 4 Spooled file exit program data Input CHAR(*)
- Return code
- OUTPUT; CHAR(1) The return code is a pointer to a structure in user domain that contains the return code from the exit program. The return code is checked on return from the call to the exit program.
Any nonzero code indicates an error with the exit program. The exit program being called must log any specific errors. Processing by the network print server continues.
Offset Type Field Dec Hex 0 0 CHAR(1) Return code
- Server information
- INPUT; CHAR(32) The server information structure contains the user profile name, server identifier, format name, and server function identifier.
The structure of server information is:
Offset Type Field Dec Hex 0 0 CHAR(10) User profile name 10 A CHAR(10) Server identifier 20 14 CHAR(8) Format name 28 1C BINARY(4) Function identifier
- Spooled file ID
- INPUT; CHAR(40) The spooled file ID structure contains the job name, user name, job number, spooled file name, and spooled file number. This information uniquely identifies a spooled file on the i5/OS.
The structure of a spooled file ID is:
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
- Spooled file exit program data
- INPUT; CHAR(*) The spooled file exit program data information structure contains a 4-byte length and the spooled file exit program data. The contents of the spooled file exit program data is not known to the network print server. The receiving exit program knows the structure of the spooled file exit program data. For example, if the exit program was going to fax the spooled file specified by the spooled file ID, the spooled file exit program data could consist of a name, telephone number, building number, and office location.
The structure of the spooled file exit program data is:
Offset Type Field Dec Hex 0 0 BINARY(4) Length of the spooled file exit program data 4 4 CHAR(*) Spooled file exit program data
Parameter field descriptions
- Format name
- The name of the format being used. For spooled file support the value is SPLF0100.
- Function identifier
- This parameter identifies, within a server, the function of the exit point. For spooled file support, the value is hex 010D.
- Job name
- The name of the job that created the spooled file.
- Job number
- The number of the job that created the spooled file.
- Server identifier
- This parameter identifies the i5/OS server being called. The value for the network print server is QNPSERVR.
- Spooled file exit program data
- Additional information used by the exit program that is registered for exit point QIBM_QNPS_SPLF. The client application provides the spooled file exit program data.
- Spooled file name
- The name of the spooled file being requested.
- Spooled file number
- The number of the spooled file being requested.
- User profile name
- The user, from IBM eServer iSeries Access for Windows, that is making the call to the network print server.