CICS_EpiGetEventExit

Function name:
CICS_EpiGetEventExit

Parameters:
Anchor
TermIndex
Wait
Event

Purpose

To allow the user to collect data relating to the event that has arrived.

When called

Immediately before CICS_EpiGetEvent returns to the caller. The exit can then examine the data returned, time the response from the system, etc.

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.