Return and Reason Codes

When the system returns control to your program:

GPR 15 (and RETCODE, if specified) contains a return code.
If the return code is not zero, GPR 0 (and RSNCODE, if specified) contains a reason code.

Note: The return and reason codes will also be put into the answer area (mapped by IXLYLAA), if there is one, when the request completes.

The IXLYCON macro provides equate symbols for the return and reason codes. The equate symbols associated with each hexadecimal return code are as follows:

0: IXLRETCODEOK
4: IXLRETCODEWARNING
8: IXLRETCODEPARMERROR
C: IXLRETCODEENVERROR
10: IXLRETCODECOMPERROR

The following table contains hexadecimal return and reason codes, the equate symbols associated with each reason code, and the meaning and suggested action for each return and reason code.

Table 1. Return and Reason Codes for IXLLIST REQUEST=LOCK Macro
Hexadecimal Return Code	Hexadecimal Reason Cod	Equate Symbol Meaning and Action
0	None.	Meaning: If you specified a MODE value of ASYNCECB, ASYNCEXIT, ASYNCTOKEN, or ASYNCNORESPONSE, the request has been successfully initiated. The answer area (ANSAREA) fields will not contain valid information until the asynchronous processing has completed. For any other MODE value, the request has successfully completed. If LOCKOPER=TEST was specified, this return code indicates the lock is held by the connection specified by CONTOKEN. Action: If you specified MODE=ASYNCECB, wait on the ECB you specified in REQECB. If you specified MODE=ASYNCEXIT, the connection's complete exit will be given control when the request has completed. If you specified MODE=ASYNCTOKEN, use REQTOKEN when calling IXLFCOMP to determine when the request has completed. If you specified MODE=ASYNCNORESPONSE, no action is required. You will not be notified when the request completes.
4	xxxx0402	Equate Symbol: IXLRSNCODEASYNCH Meaning: The request could not be processed synchronously. It will be processed asynchronously. The answer area (ANSAREA) fields will not contain valid information until the asynchronous processing has completed. If MODE=SYNCECB was specified, the ECB specified for REQECB will be posted when the request has finished. If MODE=SYNCEXIT was specified, the connection's complete exit will be given control when the request has finished. If MODE=SYNCTOKEN was specified, an asynchronous request token was returned in the area specified by REQTOKEN. This request token may be specified on the IXLFCOMP macro to determine when the request has finished. Action: If you specified MODE=SYNCECB, wait on the ECB you specified in REQECB. If you specified MODE=SYNCEXIT, the connection's complete exit will be given control when the request has completed. If you specified MODE=SYNCTOKEN, use REQTOKEN when calling IXLFCOMP to determine when the request has completed.
4	xxxx0409	Equate Symbol: IXLRSNCODETIMEOUT Meaning: The request specifying LOCKOPER=READNEXT completed prematurely because it exceeded the coupling facility model-dependent time-out criteria. The index of the next lock to be processed has been returned in the answer area (field LAALOCKINDEX). Action: Reissue the request specifying for LOCKINDEX the index of the next lock to be processed. For more information about premature completion, see z/OS MVS Programming: Sysplex Services Guide.
4	xxxx040E	Equate Symbol: IXLRSNCODELOCKNOTHELD Meaning: A LOCKOPER=TEST request determined that the specified lock was not held for the specified connection. The connection ID of the lock owner is returned in the answer area (field LAACONID). Action: None necessary. If this reason code is not expected, determine who holds the lock and see if any clean-up is necessary. The lock may need to be released, or you can wait and try again.
4	xxxx0410	Equate Symbol: IXLRSNCODELOCKCOND Meaning: For a LOCKMODE=COND request, or a request that specified LOCKCOMP, the request could not be completed successfully because the specified lock is not currently held as required. The connection identifier of the lock owner is returned in the answer area (LAACONID field). Action: Retry the request, or obtain the lock as required, and retry the request. If you are unable to get the lock, check the ID in the LAACONID field and determine if some recovery is necessary.
4	xxxx0412	Equate Symbol: IXLRSNCODELOCKHELDBYSYS Meaning: The lock is not held by any connection, but instead is held by the system. For a request that specified LOCKMODE=COND or LOCKCOMP, the request could not be completed successfully because the specified lock is not currently held as required. For a request that specified LOCKOPER=READNEXT, the request found a lock that is not generally available (see field LAALOCKINDEX in the answer area). Action: Retry the request, or obtain the lock as required, and retry the request.
4	xxxx041F	Equate Symbol: IXLRSNCODENOLOCKSHELD Meaning: A request specifying LOCKOPER=READNEXT found no locks held from the LOCKINDEX lock to the end of the lock table. Action: None necessary.
8	xxxx0801	Equate Symbol: IXLRSNCODEBADPARMLIST Meaning: Program error. The parameter list for this request is not addressable. The answer area (ANSAREA) fields are not valid. Action: Verify that: The parameter list address is uncorrupted. The parameter list is addressable in the caller's primary address space. If you are issuing this macro while disabled, the parameter list resides in either page-fixed or DREF storage. If you are issuing this macro in AR-mode and you specified the parameter list address using explicit register notation, the corresponding access register was updated appropriately. If you are issuing this macro in AR-mode, SYSSTATE ASCENV=AR must be issued before issuing this macro.
8	xxxx0804	Equate Symbol: IXLRSNCODEBADVERSIONNUM (or IXLRSNCODEBADVERSION#) Meaning: The version number in the macro parameter list is not compatible with the level of XES currently being used. The answer area (ANSAREA) fields are not valid. Action: Verify that your program did not overlay the parameter list storage. Verify that your program was assembled with the correct macro library for the release of MVS™ on which your program is running.
8	xxxx080A	Equate Symbol: IXLRSNCODEBADCONTOKEN Meaning: Program error. The specified connect token (CONTOKEN) was not valid for one of the following reasons: The user with the connection identifier represented by the token has disconnected from the structure. The connector's task (the task that issued IXLCONN) ended. The specified token is not the token that was returned from IXLCONN. The request was issued from an address space other than the address space in which IXLCONN was issued. The connect token was invalidated during rebuild. The connect token was invalidated by XES. Note: The answer area (ANSAREA) fields are not valid. Action: Take the action with the corresponding meaning. Discontinue use of the structure. Perform recovery and cleanup for the structure and check the protocol for the use of the structure to determine why you did not know of the disconnection. Discontinue use of the structure. Perform recovery and cleanup for the structure and check the protocol for the use of the structure to determine why you did not know that the task ended. The contoken is returned in the CONACONTOKEN field of the answer area specified on the IXLCONN request. Issue your request from the same address space the IXLCONN was issued in. Wait for the rebuild to complete, and try again. Discontinue use of the structure. Perform recovery and cleanup for the structure.
8	xxxx0824	Equate Symbol: IXLRSNCODEWRONGSTRTYPE Meaning: Program error. The connection specified by CONTOKEN is not to a list structure. Action: Specify the appropriate CONTOKEN value, and rerun your program. The CONTOKEN is returned in the answer area provided on the IXLCONN invocation. The type of structure built is passed on the TYPE parameter of the IXLCONN macro.
8	xxxx0838	Equate Symbol: IXLRSNCODEBADANSAREA Meaning: Program error. The storage area specified by ANSAREA is not addressable. Action: Ensure that: The answer area address specified by ANSAREA is valid. If the caller is running in AR-mode and the ANSAREA parameter was specified using explicit register notation, the corresponding access register was updated appropriately. The address specified for ANSAREA is addressable in the caller's primary address space or from the caller's PASN access list. If you are calling IXLLIST while disabled, ANSAREA must reside in either page-fixed or DREF storage. If you are calling IXLLIST in AR-mode, SYSSTATE ASCENV=AR must be issued before the IXLLIST macro.
8	xxxx0839	Equate Symbol: IXLRSNCODEBADREQTOKENAREA Meaning: Program error. The storage area specified by REQTOKEN is not addressable. Action: Ensure that: The request token area specified by REQTOKEN is valid. If the caller is running in AR-mode and the REQTOKEN parameter was specified using explicit register notation, the corresponding access register was updated appropriately. If you are calling IXLLIST while disabled, REQTOKEN must reside in either page-fixed or DREF storage. If you are calling IXLLIST in AR-mode, SYSSTATE ASCENV=AR must be issued before the IXLLIST macro.
8	xxxx083D	Equate Symbol: IXLRSNCODEBADANSLEN Meaning: Program error. The length of the answer area, as specified by ANSLEN, is not sufficient to contain answer area information. The answer area (ANSAREA) fields do not contain valid information. Action: Increase the size of the answer area, and rerun your program. The minimum size of the ANSAREA is in the LAA_LEN field of the IXLYLAA mapping macro.
8	xxxx0842	Equate Symbol: IXLRSNCODEPERSISTENTLOCK Meaning: Program error. The request specifying LOCKOPER=SET with LOCKMODE=UNCOND failed because the lock is held by a connection that is in the failed-persistent state. The connection identifier of the lock owner is returned in the answer area (field LAACONID). Action: Either perform recovery for the connection, or wait until recovery for the connection is performed.
8	xxxx0846	Equate Symbol: IXLRSNCODEBADLOCKINDEX Meaning: Program error. The specified LOCKINDEX exceeds the size of the lock table for the structure. Action: Correct LOCKINDEX to specify an index that is contained within the lock table. The maximum value for the LOCKINDEX is one less than the value specified by the LOCKENTRIES parameter on the IXLCONN macro.
8	xxxx0848	Equate Symbol: IXLRSNCODEBADRESET Meaning: Program error. LOCKOPER=RESET was specified for a lock not currently held by the invoker. The value of the connection ID holding the lock is returned in the answer area (field LAACONID). Action: Check your code to ensure that your connection did not already reset the lock.
8	xxxx084B	Equate Symbol: IXLRSNCODENOLOCKS Meaning: Program error. A locking operation was requested, but the structure does not contain a lock table. Action: Ensure that: You are connected to the intended structure. You intended to perform a locking operation. The use of locks is determined by the LOCKENTRIES keyword on the IXLCONN macro.
8	xxxx0851	Equate Symbol: IXLRSNCODENOSUSPENDISABLE Meaning: Program error. The request failed because MODE=SYNCSUSPEND was specified, but the caller is disabled and cannot be suspended. Action: Either specify another MODE value, or become enabled (release the CPU lock), then reissue the request.
8	xxxx0854	Equate Symbol: IXLRSNCODEBADLOCKCOMP Meaning: Program error. The connection identifier specified for LOCKCOMP is not valid. Action: The connection identifier is returned in the answer area (mapped by IXLYCONA) when the IXLCONN macro was issued.
C	xxxx0C06	Equate Symbol: IXLRSNCODENOCONN Meaning: Environmental error. This system does not have connectivity to the coupling facility that contains the list structure. Possible reasons for this are: The operator issued VARY PATH,OFFLINE. The operator issued CONFIG CHP,OFFLINE. Hardware errors to the coupling facility. Facility or path failure to the coupling facility. Action: Begin rebuilding the structure on a different coupling facility, or disconnect from the structure.
C	xxxx0C13	Equate Symbol: IXLRSNCODEREQPURGED Meaning: Environmental error. The request was purged prior to completion of the request. Possible reasons include: The connector failed. The connector disconnected. The requestor failed. The request was purged by IXLPURGE. Requests were purged when the connector provided an IXLEERSP response for the Rebuild Stop or Rebuild Cleanup event. The secondary address space was no longer valid. Action: None if this is expected. Otherwise, determine why the connector failed.
C	xxxx0C14	Equate Symbol: IXLRSNCODESTATUSUNKNOWN Meaning: Environmental error. The request has completed, but the final disposition of the request cannot be determined. The answer area (ANSAREA) fields do not contain valid information. Action: Verify the validity of your data by comparing the expected results with what is in the coupling facility. Consider running rebuild processing to move the structure to attempt to protect it from further errors of this kind.
C	xxxx0C25	Equate Symbol: IXLRSNCODESTRFAILURE Meaning: Environmental error. The list structure failed prior to completion of the request. Action: Either rebuild or disconnect from the structure.
C	xxxx0CA0	Equate Symbol: IXLRSNCODEQUIESCEDSUSPENDFAIL Meaning: Environmental error. The request is failed because the structure is quiesced for a system-managed process and SUSPEND=FAIL is specified on the IXLCONN. Action: None, if this is expected.
C	xxxxFFFF	Equate Symbol: IXLRSNCODENOTAVAILABLE Meaning: Environmental error. XES functions are not available. This could occur because the coupling facility hardware necessary to provide XES functions is not present. Action: Re-IPL the system, or follow your particular failure management protocol.
10	xxxx10xx	Meaning: System error. XES processing failure. The state of the involved structure and the disposition of the request are unpredictable. The answer area (ANSAREA) fields do not contain valid information. Action: Contact the IBM® support center.