Resource manager interface program exits XRMIIN and XRMIOUT

Exit XRMIIN

When invoked
Before a task-related user exit program is invoked due to an application program issuing an RMI API request.
Exit-specific parameters
UEPTRUEN
Address of the name of the task-related user exit program.
UEPTRUEP
Address of the parameter list to be passed to the task-related user exit program. See note.
UEPRECUR
Address of a halfword recursion counter. The counter is set to 0 when the exit is first invoked, and is incremented for each recursive call.
Note:
The task-related user exit program’s parameter list is mapped by a DFHUEPAR DSECT that shares common field names with the global user exit program’s DFHUEPAR parameter list. To include both DSECT definitions in your exit program, you must code:
DFHUEXIT TYPE=EP,ID=XRMIIN
DFHUEXIT TYPE,TYPE=RM

The statements must be coded in this order.

The two DFHUEPAR parameter lists, the global user exit’s and the task-related user exit’s, occupy separate areas of storage. The task-related user exit’s parameter list is provided for information only; you should not amend it in any way.

Return codes
UERCNORM
Continue processing.
UERCPURG
Task purged during XPI call.
XPI calls
All can be used.
API and SPI commands
All except EXEC CICS SHUTDOWN and EXEC CICS XCTL can be used. However, CALLDLI, EXEC DLI, or EXEC SQL commands must not be used.

Exit XRMIOUT

When invoked
After a task-related user exit program has returned from handling an RMI API request.
Exit-specific parameters
UEPTRUEN
Address of the name of the task-related user exit program.
UEPTRUEP
Address of the parameter list passed to the task-related user exit program. See note.
UEPRECUR
Address of a halfword recursion counter. The counter is set to 0 when the exit is first invoked, and is incremented for each recursive call.
Note:
The task-related user exit program’s parameter list is mapped by a DFHUEPAR DSECT that shares common field names with the global user exit program’s DFHUEPAR parameter list. To include both DSECT definitions in your exit program, you must code:
DFHUEXIT TYPE=EP,ID=XRMIOUT
DFHUEXIT TYPE,TYPE=RM

The statements must be coded in this order.

The two DFHUEPAR parameter lists, the global user exit’s and the task-related user exit’s, occupy separate areas of storage. The task-related user exit’s parameter list is provided for information only; you should not amend it in any way.

Return codes
UERCNORM
Continue processing.
UERCPURG
Task purged during XPI call.
XPI calls
All can be used.
API and SPI commands
All except EXEC CICS SHUTDOWN and EXEC CICS XCTL can be used. However, CALLDLI, EXEC DLI, or EXEC SQL commands must not be used.
Note:
It is not recommended that your exit program make calls to other external resource managers that use the RMI, because this causes recursion, and may result in a loop. It is your exit program’s responsibility to avoid entering a loop. It could use the recursion counter field UEPRECUR to guard against this.

Related concepts
Overview -- what is a global user exit?
Overview of the XPI
Global user exit XPI examples, showing the use of storage
Related tasks
Writing global user exit programs
Making an XPI call
Related reference
List of global user exit points
The XPI functions
[[ Contents Previous Page | Next Page Index ]]