CICS_EpiPurgeTerminal

The CICS_EpiPurgeTerminal function purges a previously added terminal resource.

The application does not consider the deletion complete until it receives the corresponding CICS_EPI_EVENT_END_TERM event.

The CICS_EpiPurgeTerminal call differs from the CICS_EpiDelTerminal call in that the application does not have to wait until the current transaction finishes or process all outstanding events before issuing the call.

If the terminal resource was autoinstalled, its definition is deleted from the server.

This purge function does not cancel ATI requests already received by the server, and queued against the terminal.

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_IN_CALLBACK
The function was called from a callback routine.
CICS_EPI_ERR_VERSION
The function is not supported for the version at which the EPI was initialized.
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/cclnam0065.html