Exit XICEREQ

Using XICEREQ, you can analyze the request to determine its type, the keywords specified, and their values; modify any value specified by the request before the command is executed; and set return codes to specify whether CICS® should continue with or bypass the request.

When the exit is invoked
On entry to the interval control program, before CICS processes an interval control API request.
Exit-specific 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. This allows you, for example, to pass a work area to exit XICEREQC.
UEPRCODE
Address of a 6-byte hexadecimal copy of the EIB return code ‘EIBRCODE'. For details of EIB return codes, refer to 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. The counter is set to 0 when the exit is first invoked, and is incremented for each recursive call.
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.
UERCBYP
The interval control EXEC interface program should ignore this request.
UERCPURG
Task purged during XPI call.
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 can be used, except for:
  • EXEC CICS SHUTDOWN
  • EXEC CICS XCTL
Note: Take care when issuing recursive commands not to cause a loop. For example, it is your responsibility to avoid entering a loop when an interval control request is issued from the XICEREQ exit. Use of the recursion counter UEPRECUR is recommended.