CICS_EciSystemIdExit

Function name:
CICS_EciSystemIdExit

Parameters:
Anchor
Token
ParmPtr
Reason

Purpose

To allow the user to supply a new system name when the name supplied in the ECI parameter block is not valid.

When called

This exit is called when an error occurs that may be corrected by selection of a new system, userid, or password. This would be when the ECI has returned one of the following codes:

It may be called when either when the Client daemon detects an error before data is sent to the server, or after data returns from the server.

Parameters

Anchor
Input parameter. The pointer set up by CICS_EciInitializeExit.
Token
Input parameter. The identification token established by the ECI for this request.
ParmPtr
Input parameter. A pointer to the ECI parameter block. The exit must treat all fields in the ECI parameter block as inputs, except the following, which it may set:
  • eci_system_name
  • eci_userid
  • eci_password.
Reason
Input parameter. A standard ECI error code that explains why the application request has not so far succeeded.

Return codes

CICS_EXIT_OK
The ECI retries the application call using the new parameters in the ECI parameter block. (The CICS® program communication area supplied by the application to the CICS_ExternalCall is preserved.) The application callback routine will not be called, nor will CICS_EciExternalCallExit2.
CICS_EXIT_BAD_ANCHOR
CICS detected an invalid anchor field. The ECI writes a CICS Transaction Gateway trace record, and then returns to the application that issued the CICS_ExternalCall request.
CICS_EXIT_BAD_PARM
CICS detected an invalid parameter. The ECI writes a CICS Transaction Gateway trace record, and then returns to the application that issued the CICS_ExternalCall request.
CICS_EXIT_GIVE_UP
The ECI returns to the application that issued the CICS_ExternalCall request.
user-defined
User-defined return codes must have a value not less than CICS_EXIT_USER_BASE. The ECI writes a CICS Transaction Gateway trace record, and then retries the application call as described for CICS_EXIT_OK.