Exit XICEREQC

Exit XICEREQC is invoked after an interval control API request has completed, and before return from the interval control EXEC interface program.

When examining return codes, refer to the EIBRCODE value. For more information, see EXEC interface block (EIB).

When invoked
After an interval control API request has completed, and before return from the interval control EXEC interface program.
Exit-specific parameters
UEPCLPS
Address of the command-level parameter structure. See The UEPCLPS exit-specific parameter.
UEPICTOK
Address of a 4-byte token passed from XICEREQ. This allows XICEREQ to, for example, pass a work area to 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 increments 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.
UEP_IC_REMOTE_SYSTEM
If the request is to be sent to a remote region, is the address of an area containing the 4-byte name of the remote region. (The remote region may have been specified by, for example, the SYSID option of the START command, workload management, or the REMOTESYSTEM option of the TRANSACTION definition.)

If the request is to be executed on the local region, this parameter is the address of a 4-byte area containing blanks.

UEP_IC_REMOTE_NAME
If the transaction is to be executed in a remote system, is the address of an area containing the name of the transaction, as it is known in the remote system.

The remote system may be another CICS® region, or an IMS system. If UEP_IC_REMOTE_SYSTEM names a CICS region, the name is 1 through 4 characters long. If UEP_IC_REMOTE_SYSTEM names an IMS system, the name is 1 through 8 characters long. IMS uses 8-character names: if UEP_IC_REMOTE_NAME has fewer than 8 characters, IMS translates it into a usable format.

Return codes
UERCNORM
Continue processing.
UERCPURG
Task purged during XPI call.
XPI calls
All can be used.

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. For example, you must avoid entering a loop when issuing an interval control request from the XICEREQC exit. Use of the recursion counter UEPRECUR is recommended.