CICS_EpiGetEvent

The CICS_EpiGetEvent function obtains information about an event that has occurred for a terminal resource.

Remember that this call can be attempted only from the application, not from the callback routine.

Parameters

TermIndex
The terminal index of the terminal resource for which to obtain an event. This can be set to the constant CICS_EPI_TERM_INDEX_NONE to indicate that the next event for any terminal resource used by this application is to be returned. The application can examine the TermIndex field in the returned CICS_EpiEventData_t structure to determine the terminal resource against which the event was generated.

The EPI uses this parameter for both input and output.

Wait
An indication of what happens if no event has been generated for the terminal resource. Use one of the following values:
CICS_EPI_WAIT
Do not return until the next event occurs.
CICS_EPI_NOWAIT
Return immediately with an error code. This option is used if the application elects to poll for events.
The EPI uses this parameter only for input.
Event
A pointer to a CICS_EpiEventData_t structure that on return contains the details of the event that occurred. The Data field in the structure must be set to point to the data buffer that is updated with any terminal data stream associated with the event. The Size field must be set to indicate the maximum size of this buffer, and is updated to contain the actual length of data returned.

Return codes

CICS_EPI_ERR_BAD_INDEX
The TermIndex value is not a valid terminal index.
CICS_EPI_ERR_FAILED
The function failed for an unexpected reason.
CICS_EPI_ERR_MORE_DATA
The supplied data buffer was not large enough to contain the terminal data; the data has been truncated.
CICS_EPI_ERR_MORE_EVENTS
An event was successfully obtained, but there are more events outstanding against this terminal resource.
CICS_EPI_ERR_NO_EVENT
No events are outstanding for this terminal resource.
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize has not been executed.
CICS_EPI_ERR_WAIT
The Wait parameter is not valid.
CICS_EPI_ERR_NULL_PARM
Event is a null pointer.
CICS_EPI_ERR_IN_CALLBACK
The function was called from a callback routine.
CICS_EPI_NORMAL
The function completed successfully, and there are no more events.

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/cclnam0070.html