CICS_EpiReply

CICS_EpiReply

TermIndex
Data
Size

Purpose

The CICS_EpiReply function sends data from a terminal resource to a CICS® transaction. It should only be issued in response to a CICS_EPI_EVENT_CONVERSE event.

Parameters

TermIndex
The terminal index of the terminal resource from which the data is being sent.

The EPI uses this parameter only for input.

Data
A pointer to the 3270 data stream to be sent to the transaction. This parameter must not be a null pointer, because the data stream must contain at least an AID byte. The data stream might be one byte (an AID byte), 3 bytes (an AID byte and a cursor address), or more than 3 bytes (an AID byte, a cursor address, and data and SBA commands). In the last case, what follows the cursor address is supplied to the transaction program on the first EXEC CICS RECEIVE command.

The length of the 3270 data stream must not exceed the value that was returned in MaxData in CICS_EpiDetails_t when the terminal resource was installed with CICS_EpiAddTerminal.

The EPI uses this parameter only for input.

Size
The size of the data in bytes.

The EPI uses this parameter only for input.

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_NO_CONVERSE
No reply is expected by the terminal resource.
CICS_EPI_ERR_NO_DATA
No reply data was supplied.
CICS_EPI_ERR_NOT_INIT
CICS_EpiInitialize has not been executed.
CICS_EPI_ERR_IN_CALLBACK
The function was called from a callback routine.
CICS_EPI_ERR_SERVER_DOWN
The function failed because the server was down.
CICS_EPI_ERR_ABENDED
The read timeout period has expired and the conversation has abended, but the CICS_EPI_EVENT_END_TRAN event has not yet been received by the application.
CICS_EPI_NORMAL
The function completed successfully.