User exit parameter lists

When a task-related user exit program is invoked, the CICS® management module that handles task-related user exits provides the exit program with a parameter list. The address of this parameter list is passed in register 1.

The list contains the following information:
  • The identity of the caller
  • Addresses and sizes of any work areas that are available to the task-related user exit program
  • The address of the register save area of the caller
  • The address of an EXEC interface block (EIB) that is for use by the task-related user exit program during this invocation
  • The address of the identifier of the current unit of recovery
  • The address of the schedule flag word
  • The address of the kernel stack entry
  • The address of the APPC unit of work (UOW) identifier
  • The address of the user security block flag
  • The address of the user security block
  • The address of the resource manager qualifier name
  • The address of the resource manager's single-update and read-only indicator byte
  • The address of the caller's AMODE indicator byte
  • The address of the application's DATALOC and TASKDATAKEY indicator byte
  • The address of the performance block token
  • The address of a trace flag.
To enable your exit program to access this parameter list, you must include in it the macro as follows: 
DFHUEXIT TYPE=RM
The DFHUEXIT TYPE=RM macro causes the assembler to create the storage definitions (DSECTs) DFHUEPAR, DFHUERTR, and DFHUECON. If you want your task-related user exit to be able to format screens for EDF, you must include in it the macro as follows: 
DFHUEXIT TYPE=RM,DSECT=EDF
This causes the assembler to create the UEPEDFRM DSECT, which is described in CICS EDF build parameters. All of the user exit parameter lists are summarized in Summary of the task-related user exit parameter lists.

The following information describes the format and the purpose of these definitions.