Exit XICERES
Exit XICERES is invoked by the interval control program. You can use XICERES to check that all resources required by the transaction to be started are available on the target region.
- When the exit is invoked
- Before processing of a non-terminal-related EXEC CICS START request that has been dynamically routed to this region where the routing region supports the “resource unavailable” condition (RESUNAVAIL).
- Exit-specific parameters
- Note: CICS® ignores any changes made by the exit program to the values of any of the exit parameters. Your exit program can set a return code, but not change any parameters.
- UEPCLPS
- Address of the command-level parameter structure. See The UEPCLPS exit-specific parameter.
- UEPICTOK
- Address of a 4-byte token to be passed to XICEREQC.
- UEPRCODE
- Address of a 6-byte hexadecimal copy of the EIB return code ‘EIBRCODE'. For details of EIB return codes, see EIB fields.
- UEPRESP
- Address of a 4-byte binary copy of the EIB response code ‘EIBRESP'.
- UEPRESP2
- Address of a 4-byte binary copy of the EIB response code ‘EIBRESP2'.
- UEPTSTOK
- Address of a 4-byte token that is valid throughout the life of a task. See Using the task token UEPTSTOK.
- UEPRECUR
- Address of a halfword recursion counter. Because the XICERES exit can never be called recursively in the same transaction, the value of this field is always 0.
- UEPRSRCE
- Address of an 8-character copy of the EIB resource value, EIBRSRCE.
- UEPDATE
- Address of a fullword copy of the EIB date value, EIBDATE.
- UEPTIME
- Address of a fullword copy of the EIB time value, EIBTIME.
- Return codes
-
- UERCNORM
- Continue processing.
- UERCPURG
- Task purged during XPI call.
- UERCRESU
- A required resource is unavailable. Setting this value causes CICS to reject the routed request, and to return a value of 'F' (resource unavailable) in the DYRERROR field of the routing program's communications area.
- XPI calls
- All can be used. You can also use EXEC CICS API commands at this
user exit.
Although the exit permits the use of XPI GETMAIN and FREEMAIN calls, you are recommended to use the EXEC CICS GETMAIN and FREEMAIN commands instead.
- API and SPI commands
- All except EXEC CICS SHUTDOWN and EXEC CICS XCTL can be used.