Loader domain exits XLDLOAD and XLDELETE

There are two global user exits in the loader domain. XLDLOAD is invoked when a new instance of a program is loaded into storage, before the program is made available for use.

XLDELETE is invoked after an instance of a program is released by CICS® and before the program is freed from storage.

For LPA-resident programs, the exits are still invoked when a program is acquired or released, even though the program is not physically loaded or freed.

These are both information-only exits. Any changes made to the exit parameters by the exit program are ignored by CICS, as is any return code which it sets.

Exit XLDLOAD

When invoked
After an instance of a program is brought into storage, and before the program is made available for use.
Exit-specific parameters
UEPPROGN
Address of an 8-character field containing the name of the program that is being loaded.
UEPPROGL
Address of a 4-byte field containing the length, in bytes, of the program that is being loaded.
UEPLDPT
Address of a 4-byte field containing the address at which the program has been loaded.
UEPENTRY
Address of a 4-byte field containing the address of the program’s entry point.
UEPTRANID
Zero, or the address of a 4-byte field containing the transaction ID which applied when the exit was invoked.
UEPUSER
Zero, or the address of an 8-byte field containing the userid in control at the time the exit was invoked.
UEPTERM
Zero, or the address of a 4-byte field containing the terminal name associated with the transaction under which the exit was invoked.
UEPPROG
Zero, or the address of an 8-character field containing the name of the program that was in control at the time the exit was invoked.
Return codes
UERCNORM
Continue processing.
XPI calls
Must not be used.
API and SPI calls
Must not be used.

Exit XLDELETE

When invoked
After an instance of a program is released by CICS, and before the program is freed from storage.
Exit-specific parameters
UEPPROGN
Address of an 8-character field containing the name of the program that is being freed.
UEPPROGL
Address of a 4-byte field containing the length, in bytes, of the program that is being freed.
UEPLDPT
Address of a 4-byte field containing the address at which the program resides in storage.
UEPENTRY
Address of a 4-byte field containing the address of the program’s entry point.
UEPTRANID
Zero, or the address of a 4-byte field containing the transaction ID which applied when the exit was invoked.
UEPUSER
Zero, or the address of an 8-byte field containing the userid in control at the time the exit was invoked.
UEPTERM
Zero, or the address of a 4-byte field containing the terminal name associated with the transaction under which the exit was invoked.
UEPPROG
Zero, or the address of an 8-character field containing the name of the program that was in control at the time the exit was invoked.
Return codes
UERCNORM
Continue processing.
XPI calls
Must not be used.
API and SPI calls
Must not be used.

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 ]]