CICS_EpiTermIdExit

Function name:
CICS_EpiTermIdExit

Parameters:
Anchor
TermIndex
System

Purpose

To allow the user to know the terminal index allocated after a successful call to CICS_EpiAddTerminal.

CICS_EpiTermIdExit is provided for compatibility with older applications only. All new applications that use the EPI exits should use CICS_EpiTermIdInfoExit instead.

When called

On each invocation of CICS_EpiAddTerminal, after the server has allocated the terminal.

Parameters

Anchor
Input parameter. The pointer set up by CICS_EpiInitializeExit.
TermIndex
Input parameter. This is the terminal index for the terminal resource just reserved or installed.
System
Input parameter. A pointer to a null-terminated string that specifies the name of the server in which the terminal resource has been reserved or 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.