CICS_EpiTranFailedExit

This exit enables the user to collect data if an EIP transaction ends abnormally or if an EPI terminal fails.

When called

Immediately before CICS_EpiGetEvent returns to the caller, with or without GetEventExit, when the event is CICS_EPI_EVENT_END_TRAN, and the AbendCode field is not blank.

Note that there are some failures on remote systems that can occur and will simply cause the presentation of a 3270 data stream with an error message and no abend code in the CICS_EPI_EVENT_END_TRAN. This error message might not even occur on the same event as the CICS_EPI_EVENT_END_TRAN. If the exit requires to handle this situation, it can monitor it through CICS_EpiGetEventExit and scan the appropriate 3270 data streams.

Parameters

Anchor
Input parameter. The pointer set up by CICS_EpiInitializeExit.
TermIndex
Input parameter. The value to be returned to the application in the TermIndex parameter of the CICS_EpiGetEvent call to which this exit relates.
Wait
Input parameter. The value supplied for the Wait parameter of the CICS_EpiGetEvent call to which this exit relates.
Event
Input parameter. The value to be returned to the application in the Event parameter of the CICS_EpiGetEvent call to which this exit relates.

Return codes

CICS_EXIT_OK
Processing of the CICS_EpiGetEvent call continues.
CICS_EXIT_BAD_ANCHOR
CICS® detected an invalid anchor field. The EPI writes a CICS Transaction Gateway trace record, and then processing of the CICS_EpiGetEvent call continues.
CICS_EXIT_BAD_PARM
CICS detected an invalid parameter. The EPI writes a CICS Transaction Gateway trace record, and then processing of the CICS_EpiGetEvent call continues.
user-defined
User-defined return codes must have a value not less than CICS_EXIT_USER_BASE. The EPI writes a CICS Transaction Gateway trace record, and then processing of the CICS_EpiGetEvent call continues.

Reference Reference

Feedback


Timestamp icon Last updated: Tuesday, 19 November 2013


https://ut-ilnx-r4.hursley.ibm.com/tg_latest/help/topic/com.ibm.cics.tg.doc//proref/cclnam0098.html