Dfhuepar standard parameters – IBM SC33-1683-02 User Manual
Page 40
If your exit program is to be invoked at every global user exit point, you can code:
DFHUEXIT TYPE=EP,ID=ALL
If your user exit program is to be used both as a global user exit program and as a
task-related user exit program, you must code both:
DFHUEXIT TYPE=EP,ID=exit_point_identifier
and:
DFHUEXIT TYPE=RM
(in this order) to generate the DSECTs appropriate to both types of user exit.
If a global user exit program needs to use the DFHRMCAL macro to invoke an
external RMI, the DFHRMCAL macro instruction must follow the DFHUEXIT macro.
DFHUEPAR standard parameters
DFHUEPAR DSECT
* STANDARD PARAMETERS
UEPEXN
DS
A
ADDRESS OF EXIT NUMBER
UEPGAA
DS
A
ADDRESS OF GLOBAL WORK AREA
*
(ZERO = NO WORK AREA)
UEPGAL
DS
A
ADDRESS OF GLOBAL WORK AREA LENGTH
UEPCRCA DS
A
ADDRESS OF CURRENT RETURN-CODE
UEPTCA
DS
A
RESERVED
UEPCSA
DS
A
RESERVED
UEPEPSA DS
A
ADDRESS OF REGISTER SAVE AREA
*
FOR USE BY EXIT PROGRAM
UEPHMSA DS
A
ADDRESS OF SAVE AREA USED FOR
*
HOST MODULE'S REGISTERS
UEPGIND DS
A
ADDRESS OF CALLER'S TASK INDICATORS
UEPSTACK DS
A
ADDRESS OF KERNEL STACK ENTRY
UEPXSTOR DS
A
ADDRESS OF STORAGE FOR XPI PARAMETERS
UEPTRACE DS
A
ADDRESS OF TRACE FLAG
UEPEXN
points to a 1-byte binary field whose contents identify the global user exit point
from which the exit program is being invoked. You need this information if your
exit program can be invoked from more than one exit point.
DFHUEXIT TYPE=EP generates a list of equated values that relate the exit
names (exitids) to the exit numbers used internally by CICS to identify the exits.
You should always use the exitids, because the exit numbers may change in
any future releases of CICS.
UEPGAA
points to the global work area that was provided for the exit program when it
was enabled. This is set to zero if no global work area is provided.
UEPGAL
points to a halfword that contains the length of the global work area.
UEPCRCA
points to a halfword that is to contain the return code value from the exit
program. When more than one program is called at a user exit, this field
contains (on entry to the second and subsequent programs) the return code
that was set by the previously invoked program.
global user exit programs
8
CICS TS for OS/390: CICS Customization Guide