CICS_EpiTermIdInfoExit

Function name:
CICS_EpiTermIdInfoExit

Parameters:
Anchor
Version
TermIndex
EpiDetails

Purpose

To allow the user to retrieve information about the current terminal.

When called

Immediately after a CICS® terminal has been installed

Parameters

Anchor
Input parameter. The pointer set up by CICS_EpiInitializeExit.
Version
Input parameter. The EPI version.
TermIndex
Input parameter. The index of the terminal being installed.
EpiDetails
Input parameter. A pointer to the CICS_EpiDetails_t structure, containing details about the terminal being installed.

Return codes

CICS_EXIT_OK
Processing continues.
CICS_EXIT_BAD_ANCHOR
CICS detected an invalid anchor field. The EPI writes a CICS Transaction Gateway trace record, and then continues as for CICS_EXIT_OK.
CICS_EXIT_BAD_PARM
CICS detected an invalid parameter. The EPI writes a CICS Transaction Gateway trace record, and then continues as for CICS_EXIT_OK.
user-defined
User-defined return codes must have a value not less than CICS_EXIT_USER_BASE. The EPI writes a CICS Transaction Gateway trace record, and then continues as for CICS_EXIT_OK.