CICS_EpiDelTerminal

CICS_EpiDelTerminal

TermIndex

Purpose

The CICS_EpiDelTerminal function deletes a previously added terminal resource. The application should not consider the deletion complete until it receives the corresponding CICS_EPI_EVENT_END_TERM event. The terminal index remains allocated until a CICS_EpiGetEvent call retrieves the CICS_EPI_EVENT_END_TERM event. A call to this function fails if the terminal resource is currently running a transaction. To ensure that a terminal resource is deleted, the application must wait until the current transaction finishes and process all outstanding events before issuing the CICS_EpiDelTerminal call.

If the terminal resource was autoinstalled, its definition is deleted from the server. When a CICS_EpiDelTerminal call has completed successfully for a terminal resource, use of the terminal index is restricted to CICS_EpiGetEvent calls until the application has received the corresponding CICS_EPI_EVENT_END_TERM event.

Parameters

TermIndex
The terminal index of the terminal resource to be deleted.

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_NOT_INIT
CICS_EpiInitialize has not been executed.
CICS_EPI_ERR_TRAN_ACTIVE
A transaction is currently running against the terminal resource, or there are unprocessed events for the terminal resource.
CICS_EPI_ERR_IN_CALLBACK
The function was called from a callback routine.
CICS_EPI_NORMAL
The function completed successfully.