This exit enables the user to supply a new system ID, if
the value supplied in the ECI parameter block is not valid.
Function name:
CICS_EciSystemIdExit
|
Parameters:
Anchor
Token
ParmPtr
Reason
|
When called
This exit is called when an
error occurs that can be corrected by selection of a new system, user
ID, or password. This would be when the ECI has returned one of the
following codes:
- ECI_ERR_NO_CICS
- ECI_ERR_UNKNOWN_SERVER
- ECI_ERR_SECURITY_ERROR
- ECI_ERR_SYSTEM_ERROR
- ECI_ERR_RESOURCE_SHORTAGE
- ECI_ERR_MAX_SYSTEMS.
It can be called 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 setup 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 can 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 is not called, nor is 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.