CICS_EpiSystemIdExit

This exit enables the user to supply a new EPI system ID, if the value supplied by CICS_Epi_AddTerminal or CICS_EpiAddExTerminal is not valid.

Purpose

When called

Immediately before CICS_EpiAddTerminal or CICS_EpiAddExTerminal returns to the application when an error occurred while trying to add the terminal. The error can be CICS_EPI_ERR_SYSTEM, CICS_EPI_ERR_FAILED, or CICS_EPI_ERR_SERVER_DOWN. It occurs whether or not CICS_EpiAddTerminalExit or CICS_EpiAddExTerminal has been called previously.

Note: On some systems the completion of CICS_EpiAddTerminal or CICS_EpiAddExTerminal is returned to the application asynchronously, and in this case this exit will be called asynchronously.

Parameters

Anchor
Input parameter. The pointer set up by CICS_EpiInitializeExit.
NameSpace
Input-output parameter. The NameSpace parameter used in the failed CICS_EpiAddTerminal or CICS_EpiAddExTerminal.
System
Input-output parameter. The System parameter used in the failed CICS_EpiAddTerminal or CICS_EpiAddExTerminal.
NetName
Input-output parameter. The NetName parameter used in the failed CICS_EpiAddTerminal or CICS_EpiAddExTerminal.
DevType
Input-output parameter. The DevType parameter used in the failed CICS_EpiAddTerminal or CICS_EpiAddExTerminal.
FailedSystem
Input parameter. The identifier of the system on which the failure occurred.
Reason
Input parameter. The reason for the failure:. CICS_EPI_ERR_SYSTEM or CICS_EPI_ERR_FAILED.
SubReason
Input parameter. More about the failure.
UserId
Output parameter. Not used.
PassWord
Output parameter. Not used.

Return codes

CICS_EXIT_OK
The EPI will retry the CICS_EpiAddTerminal or CICS_EpiAddExTerminal call using the values specified as output of this exit. Note that in this case the considerations described in CICS_EpiAddTerminalExit apply.
CICS_EXIT_DONT_ADD_TERMINAL
The CICS_EpiAddTerminal or CICS_EpiAddExTerminal is ended with a return code of CICS_EPI_ERR_FAILED.
CICS_EXIT_BAD_ANCHOR
CICS® detected an invalid anchor field. The EPI writes a CICS Transaction Gateway trace record, and then the error that caused the exit to be called is returned to the application.
CICS_EXIT_BAD_PARM
CICS detected an invalid parameter. The EPI writes a CICS Transaction Gateway trace record, and then the error that caused the exit to be called is returned to the application.
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 the error that caused the exit to be called is returned to the application.

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