In the ISPF configuration table keyword file, this exit is set with keywords PRINT_UTILITY_PROGRAM_EXIT (if your exit is a program) and PRINT_UTILITY_COMMAND_EXIT (if your exit is a CLIST).

The print utility exit lets you define your own print facility to replace or supplement ISPF's print facilities. If you define a print routine for this exit, ISPF calls that routine upon ISPF termination and from ISPF's LOG and LIST commands. The print routine is also called from options 3.6, 3.8, and all 4.x options as described in Print utility exit. To define a print routine create your own JCL for batch jobs or your own local print routine such as PRINTDS. The exit parameters defined in Table 1 that are marked with an asterisk (*) are system variables. They can be modified in the exit, but they are not saved in the system profile. The variables defined as not modifiable should not be modified.

Exit parameters

ISPF 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 ISPF LOG/LIST termination and command panels.

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

Return codes

When the print exit routine is invoked upon ISPF termination or ISPF LOG or LIST commands these return codes can occur.

0

Successful termination of print routine.

Batch

Exit provides job card and other JCL needed to print the job. Exit submits the job.

Local

Exit provides necessary information to print the job. Exit issues the print command.

ISPF issues a message on return from the print utility exit, indicating the return code from the exit.

2

Successful termination of the print routine.

Exit provides job card and JCL needed to print the job. ISPF submits the JCL contained in the file pointed to by the ZTEMPF variable.

ISPF issues a message on return from the print utility exit, indicating the return code from the exit.

4

Successful termination of the print routine.

Batch

Exit may alter the modifiable variables and place them in ISPF's shared pool. ISPF submits the print job using the information in the dialog variables located in the ISPF shared pool.

Local

Exit may alter the modifiable variables and place them in ISPF's shared pool. ISPF issues the PRINTDS command using the information in the dialog variables located in the ISPF shared pool.

ISPF issues a message on return from the print utility exit, indicating the return code from the exit.

Note:

ISPF processes the data set based on the updated value of the disposition variable (ZPRLGOPT or ZPRLSOPT) for return codes 0, 2, or 4. This allows the exit to either delete the data set itself, or instruct ISPF to delete the data set. ISPF does not delete pre-allocated LOG or LIST data sets.

For return codes 0, 2, and 4, ISPF issues a message regarding the disposition of the data set. The message is based on the dialog variables ZPRLGOPT, ZPRLSOPT, ZPRLGPRT, and ZPRLSPRT located in the ISPF shared pool. The exit can suppress this message by setting variable ZPRMSGF to a value of 'S'.

20

The print routine failed. ISPF keeps the data and displays an error message.

Error processing

The exit routine is responsible for handling all errors that occur while it is in control.