User exit parameter lists – IBM SC33-1683-02 User Manual
Page 285
User exit parameter lists
When a task-related user exit is invoked, the CICS management module that
handles task-related user exits provides the exit with a parameter list. The address
of this parameter list is passed in register 1. The list contains the following
information:
v
The identity of the caller
v
Addresses and sizes of any work areas that are available to the task-related user
exit program
v
The address of the register save area of the caller
v
The address of an EXEC interface block (EIB) that is for use by the task-related
user exit program during this invocation
v
The address of the identifier of the current unit of recovery
v
The address of the schedule flag word
v
The address of the kernel stack entry
v
The address of the APPC unit of work (UOW) identifier
v
The address of the user security block flag
v
The address of the user security block
v
The address of the resource manager qualifier name
v
The address of the resource manager’s “single-update” and “read-only” indicator
byte
v
The address of the caller’s AMODE indicator byte
v
The address of the application’s DATALOC and TASKDATAKEY indicator byte
v
The address of the performance block token
v
The address of a trace flag.
To enable your exit program to access this parameter list, you must include in it the
macro:
DFHUEXIT TYPE=RM
The DFHUEXIT TYPE=RM macro causes the assembler to create the storage
definitions (DSECTs) DFHUEPAR and DFHUERTR. If you want your task-related
user exit to be able to format screens for EDF, you must include in it the macro:
DFHUEXIT TYPE=RM,DSECT=EDF
This causes the assembler to create the UEPEDFRM DSECT, which is described in
“CICS EDF build parameters” on page 261. All of the user exit parameter lists are
summarized in Figure 7 on page 264.
The format and the purpose of these definitions are described below.
DFHUEPAR
DFHUEPAR gives you the following symbolic names for address parameters:
UEPEXN
Address of the function definition, which tells the task-related user exit
program why it is being called. See “DFHUERTR (the function definition)”
on page 257 for more details.
UEPGAA
Address of the global work area requested in the EXEC CICS ENABLE
the task-related user exit program
Chapter 2. Task-related user exit programs
253