Retrieve a copy of the ECI parameter block.

 

call CICSGetError (ECIPARMS, PROGRAMID_IV)

ECIPARMS

An ECIPARMS structure that contains the updated ECIPARMS structure returned by CICS.

PROGRAMID_IV

An integer indicating the ESLCICS program, as returned by CICSInitiate.

Description

This function allows an application to retrieve a copy of the ECI parameter block containing the CICS error codes that indicate the nature of the error that occurred. It is intended to be called in a CICS stimulus error response.

This function should always be called when an error occurs and eventparam is not equal to zero (zero is never a valid ProgramID). Furthermore, you should call this function only when an error occurs. Therefore, test the value of eventparam before calling CICSGetError to make sure it is not zero. Once you have initiated a transaction, call either CICSGetData or CICSGetError. Do not call both of these functions for the same transaction ID, since they both release resources associated with the transaction.

Return Value

This function returns a value from the CICS External Call Interface (ECI) call.

Example

 

response to stimulus CICS CICSError

 

if (eventparam != 0) then

  copy eventparam to ProgramID

  copy CICSGetError (ECIParms, ProgramID) to FailCode

end if