CICS_EpiATIState

The CICS_EpiATIState function allows the calling application to query and alter the way in which ATI requests for a terminal resource are handled.

If ATI requests are enabled (CICS_EPI_ATI_ON) and an ATI request is issued in the server, the request is started when the terminal resource becomes free. If ATI requests are held (CICS_EPI_ATI_HOLD), any ATI requests issued are queued, and started when ATI requests are next enabled.

The state for ATI requests after a CICS_EpiAddTerminal call is CICS_EPI_ATI_HOLD. The EPI application might change the state to CICS_EPI_ATI_ON when it is ready to allow ATI requests to be processed. (The server also maintains a ATI state for terminal resources, which is independent of the ATI state maintained in the EPI. Changes to the ATI state on the server do not affect the ATI status in the EPI.)

Parameters

TermIndex
The terminal index of the terminal resource with the ATI state that is required.

The EPI uses this parameter only for input.

ATIState
The EPI uses this parameter for both input and output depending on the input value as follows:
CICS_EPI_ATI_ON
Enable ATI requests, and return the previous ATI state in this parameter.
CICS_EPI_ATI_HOLD
Hold ATI requests until they are next enabled, and return the previous ATI state in this parameter.
CICS_EPI_ATI_QUERY
Do not change the ATI state; just return the current state in this parameter.

Return codes

CICS_EPI_ERR_ATI_STATE
An invalid ATIState value was provided.
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_NOT_INIT
CICS_EpiInitialize has not been executed.
CICS_EPI_ERR_IN_CALLBACK
The function was called from a callback routine.
CICS_EPI_NULL_PARAM
ATIState was a null pointer.
CICS_EPI_NORMAL
The function completed successfully.

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