Exit XPCERES
Exit XPCERES is invoked by the EXEC interface program, before processing of a program link or Link3270 bridge request that has been dynamically routed to this region, where the routing region supports the “resource unavailable” condition.
- 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 parameter list.
- UEPPCTOK
- Address of a 4-byte token to be passed to XPCREQC.
- UEPRCODE
- Address of a 6-byte hexadecimal copy of EIBRCODE.
- UEPRECUR
- Address of a halfword recursion counter. Because the XPCERES exit can never be called recursively in the same transaction, the value of this field is always 0.
- UEPRESP
- Address of a 4-byte copy of EIBRESP.
- UEPRESP2
- Address of a 4-byte copy of EIBRESP2.
- UEPTSTOK
- Address of a 4-byte token that is valid throughout the life of a task. See Using the task token UEPTSTOK.
- UEPRSRCE
- Address of an 8-character copy of the EIB resource value, EIBRSRCE.
- UEP_PC_PBTOK
- Address of a 4-byte field containing the z/OS® Workload Manager (WLM) Performance Block Token. An exit program can use this token to access information (such as the service class token, SERVCLS) in the WLM Performance Block. To do so, it must use the WLM EXTRACT macro, IWMMEXTR, passing the Performance Block Token as the MONTKN input parameter. For more information about the IWMMEXTR macro, see z/OS MVS Programming: Workload Management Services.
An exit program must not attempt to modify the Performance Block: if it does so, the results are unpredictable.
- 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.
Although the exit permits the use of XPI GETMAIN and FREEMAIN calls, we recommend that you use the EXEC CICS GETMAIN and FREEMAIN commands instead.
- API and SPI calls
- All except EXEC CICS SHUTDOWN and EXEC CICS XCTL can be used.