Print utility exit

The Print utility exit receives control from ISPF in two distinct modes:

Print utility exit for general printing (described here).
Print utility exit on ISPF termination and LOG/LIST commands (see Print utility exit on ISPF termination and LOG/LIST commands).

In the ISPF configuration table keyword file, this exit is set with keywords PRINT_UTILITY_PROGRAM_EXIT and PRINT_UTILITY_COMMAND_EXIT.

The print utility exit lets you define your own print facility to replace or supplement PDF's print facilities. If you define a print routine for this exit, PDF calls that routine from options 3.6, 3.8, and all 4.x options. The print routine is also called on ISPF termination and for the LOG and LIST commands as described in Print utility exit on ISPF termination and LOG/LIST commands. The print routine can:

Define its own print facility or use the TSO/E Information Center Facility printer definitions. To indicate that you are using the TSO/E Information Center Facility printer definitions, set the PRINT_USING_ICF keyword in the ISPF configuration table to YES.
Specify additional print options.
Supply print parameters automatically.
Censor print requests.

Exit parameters

PDF communicates with the installation-written print routine through dialog variables in the ISPF shared pool. PDF passes data set, job card, and print option information to the print routine that you supply on the PDF print panels. As a system programmer, you can modify those print panels so that the print routines receive more or less information.

If variable ZPRLGLST is not defined or does not have a value of LOG or LIST, then the variables shown in Table 1 are available to the print exit routine. However, if variable ZPRLGLST has a value of LOG or LIST, then the variables shown in Table 1 are available to the print exit routine.

Table 1. Variables available to the print exit routine.
Variable	Type	Len	Description	Modifiable
ZPRDSN	CHAR	44	Fully qualified data set name (no quotes) of the data set to be printed	No
ZPRMEM	CHAR	8	Member to be printed, if the data set is a partitioned data set and a member is defined	No
ZPRPMD	CHAR	5	Print mode - BATCH, LOCAL, or TSO/E ICF	Yes
ZPROPT	CHAR	1	Disposition of the data set as specified by the user - K (keep) or D (delete)	Yes
ZPRDSORG	CHAR	8	Organization of the data set - PO or PS	No
ZPRRECFM	CHAR	6	Record format of the data set	No
ZPRLRECL	CHAR	5	Logical record length of the data set	No
ZPRBLKSZ	CHAR	5	Physical block size of the data set	No
ZPRVOLSE	CHAR	6	Volume serial of the data set	No
ZPRPASS	CHAR	8	Data set password (if it is password protected)	No
ZPRSYSO	CHAR	80	Batch SYSOUT class as specified by the user	Yes
ZPRSYSOL	CHAR	80	Local SYSOUT class as specified by the user	Yes
ZPRLPRT	CHAR	8	Local printer ID as specified by the user	Yes
ZPRICFPL	CHAR	15	TSO/E Information Center Facility printer location as specified by the user	Yes
ZPRICFPF	CHAR	8	TSO/E Information Center Facility printer format as specified by the user	Yes
ZPRICFPT	CHAR	8	TSO/E Information Center Facility printer type as specified by the user	Yes
ZPRICFNC	CHAR	3	TSO/E Information Center Facility number of copies as specified by the user	Yes
ZPRICFEF	CHAR	1	TSO/E Information Center Facility enable font selection	Yes
ZPRJB1	CHAR	72	Print job card 1 as specified by the user	Yes
ZPRJB2	CHAR	72	Print job card 2 as specified by the user	Yes
ZPRJB3	CHAR	72	Print job card 3 as specified by the user	Yes
ZPRJB4	CHAR	72	Print job card 4 as specified by the user	Yes

Return codes

0: Successful termination of print routine. PDF does no further processing.
2: Successful termination of print routine. PDF submits any generated JCL.
4: Successful termination of print routine. PDF prints the data according to the information in the dialog variables located in the ISPF shared pool. If no message is waiting to be displayed, PDF issues a message.
20: Installation print routine failed. PDF keeps the data and, if the installation print exit has issued an ISPF SETMSG service request, ISPF displays the requested message.

Note: ISPF processes the data set based on the updated value of the ZPROPT variable for return codes 0, 2, or 4. This allows the exit to delete the data set or instruct ISPF to delete the data set. ZPROPT cannot be set to a value of 'D' for PDS or PDSE data sets.

Error processing

The installation-wide exit routine is responsible for handling all errors that occur while it is in control. The TSO/E Information Center Facility handles all error conditions while it is in control. In addition, PDF displays any error messages generated by the TSO/E Information Center Facility on the current print panel.