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 IXLLSTC Macro
Hexadecimal Return Code	Hexadecimal Reason Code	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. 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.
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 IXLLSTC request completed prematurely because it exceeded the coupling facility model-dependent time-out criteria. The following information has been returned in the answer area: For a MONITOR_SUBLISTS request, the index of the first unprocessed IXLYMSRI entry. All prior IXLYMSRI entries were processed. For a DEQ_EVENTQ request, the number of EMCs that were dequeued from the user's event queue, and the number of EMCs that remain on the user's event queue after dequeueing those EMCs. For a LOCK request, the index of the next lock to be processed. For WRITE_LCONTROLS and MONITOR_KEYRANGE requests, no specific information is returned in the answer area. However, if a WRITE_LCONTROLS request specifies the NEWAUTH keyword, the list authority is replaced with the new value. Action: For WRITE_LCONTROLS, issue a new KEYRANGE=SET request that specifies the same key range as the original request. Any such request that specifies the AUTHCOMP keyword should use the new list authority value. For other request types, reissue the request to continue. Be sure to process the information returned from this request before reissuing the request. The data returned from this request will be overwritten if you specify the same buffer address. Continue to reissue the request until the return code indicates that all processing has completed. For more information about premature completion of an IXLLSTC request, 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 either LOCKOPER=READNEXT or LOCKOPER=TEST, the request could not be completed successfully because the specified lock is not generally available. 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	xxxx0825	Equate Symbol: IXLRSNCODENOENTRY Meaning: Program error. The designated event monitor controls object (EMC) does not exist for the user of the designated sublist. Action: None necessary. However, if this return code and reason code are unexpected, you should examine the parameters specified for the list number and entry key on the invocation of this macro.
8	xxxx082B	Equate Symbol: IXLRSNCODEBADIDINDEX Meaning: Program error. The value specified for either STARTINDEX or ENDINDEX was not valid. No entries were processed. The index of the first entry that was not processed is returned in the answer area. Action: Ensure that the STARTINDEX and ENDINDEX values are valid and resubmit the request.
8	xxxx0833	Equate Symbol: IXLRSNCODEBADPGBLATTR Meaning: Program error. The storage area specified by BUFFER, or one of the buffers in the BUFLIST list is specified as being pageable (PAGEABLE=YES), but is not. Action: Change the buffer area(s) to pageable storage, or specify PAGEABLE=NO. See the PAGEABLE parameter description for specification instructions.
8	xxxx0834	Equate Symbol: IXLRSNCODEBADNONPGBLATTR Meaning: Program error. The storage area specified by BUFFER, or one of the buffers in the BUFLIST list, is specified as being nonpageable (PAGEABLE=NO), but is either pageable or not addressable. Action: Ensure that: The type of storage in the buffer area corresponds to the value you specified on the PAGEABLE parameter. See the PAGEABLE parameter description for specification instructions. The correct buffer address was used. The buffer area was not previously freed. If you are calling IXLLIST while disabled, the buffers must reside in either page-fixed or DREF storage. The buffer areas were allocated in a storage key that matches the key specified by the BUFSTGKEY parameter, or, if BUFSTGKEY is omitted, the caller's PSW key. If BUFLIST was specified and your program is running in AR-mode: If the BUFFER or BUFLIST parameter was specified using explicit register notation, the corresponding access register was updated appropriately. The BUFALET specification is correct. You specified SYSSTATE ASCENV=AR before issuing the IXLLIST macro.
8	xxxx0835	Equate Symbol: IXLRSNCODEBADDATAADDR Meaning: Program error. The storage area specified by BUFFER, or one of the buffers in the BUFLIST list, is not addressable. Action: Ensure that: The correct buffer address was used. The buffer area was not previously freed. The buffer area was allocated in a storage key that matches the key specified using the BUFSTGKEY parameter, or, if BUFSTGKEY is omitted, the caller's PSW key. If BUFLIST was specified and your program is running in AR mode: The BUFALET specification is correct. You specified SYSSTATE ASCENV=AR before issuing the macro.
8	xxxx0836	Equate Symbol: IXLRSNCODEBADREALADDR Meaning: Program error. Real storage addresses were provided in the BUFLIST list, but one of the buffers is not addressable in central storage. Action: Verify that BUFADDRTYPE was specified as you intended. Ensure that the buffer addresses specified by BUFLIST are valid.
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 IXLLSTC while disabled, ANSAREA must reside in either page-fixed or DREF storage. If you are calling IXLLSTC in AR-mode, SYSSTATE ASCENV=AR must be issued before the IXLLSTC 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 IXLLSTC while disabled, REQTOKEN must reside in either page-fixed or DREF storage. If you are calling IXLLSTC in AR-mode, SYSSTATE ASCENV=AR must be issued before the IXLLSTC 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, or LOCKOPER=NOTHELD 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	xxxx0847	Equate Symbol: IXLRSNCODEBADLISTNUMBER Meaning: Program error. The specified LISTNUM value exceeds the number of lists for the structure. Action: Correct LISTNUM to specify a list number that exists in the structure. The number of lists allocated for a structure is determined on the LISTHEADERS parameter of the IXLCONN macro. The list numbers go from 0 to n-1, where n is the number of lists specified.
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	xxxx084A	Equate Symbol: IXLRSNCODENOKEYS Meaning: Program error. The structure does not support the use of entry keys. The IXLLSTC request type either required the structure to support entry keys or was a monitor request type that required a keyed structure. Action: Ensure that you are connected to the intended structure. The use of keys for a structure is determined by the REFOPTION keyword on the IXLCONN macro.
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	xxxx0852	Equate Symbol: IXLRSNCODENOLISTVECTOR Meaning: Program error. The request failed because no local vector for monitoring list headers, key ranges, or event queues exists for this connection. Either a list notification vector was not requested for this connection, or the list notification vector has been deleted. Action: Either you are not connected to this structure or the VECTORLEN parameter was not specified when the IXLCONN was done for this structure.
8	xxxx0853	Equate Symbol: IXLRSNCODEINVLISTVINDEX Meaning: Program error. The list notification vector index (VECTORINDEX) specified with ACTION=START was not valid. This might be because the vector index you specified is greater than the number of vector entries in the list notification vector. Action:Correct the VECTORINDEX that you are using.
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.
8	xxxx0859	Equate Symbol: IXLRSNCODEBADLISTAUTH Meaning: The list authority value for the specified list does not meet the criteria specified by AUTHCOMP. The current list authority (field LAALISTAUTH) and description (field LAALISTDESC) are returned in the answer area. Action: None required; however you might want to take some action depending on your application. The list authority is set to binary zeros when the structure is allocated. When IXLLSTC is issued with the NEWAUTH keyword, the list authority is changed if the correct comparison list authority value is specified. Check the answer area to determine the list authority value for the list specified. Verify that the correct list number was specified.
8	xxxx0864	Equate Symbol: IXLRSNCODEBADBUFSIZE Meaning: Program error. The size of the BUFFER area or the buffer areas specified by BUFLIST is not large enough to contain the data being read. No data is returned. Action: If more space is available, specify a larger buffer size, and reissue the request. For READ_LCONTROLS and DEQ_EVENTQ requests, the specified buffer area must be 4096 bytes in length.
8	xxxx0865	Equate Symbol: IXLRSNCODEBADBUFSPEC Meaning: Program error. There is an error in the buffer specification. Action: Check the following: If BUFLIST was specified, check the requirements for BUFLIST, BUFNUM, and BUFINCRNUM. If BUFFER was specified, check the requirements for BUFFER and BUFSIZE. Buffer pointer(s) in BUFLIST Buffer boundaries.
8	xxxx0866	Equate Symbol: IXLRSNCODEBADBUFKEY Meaning: Program error. The buffer storage key specified by BUFSTGKEY is incorrect. For requests that write coupling facility data, the data cannot be fetched from the specified buffer area. For requests that read coupling facility data, the data cannot be stored into the specified buffer area. Action: Check the following: Determine if the key of the storage being used for the buffers is different from the PSW key. If BUFSTGKEY was specified, verify that the key was put in the correct bits (see the explanation of this parameter for more information). If you are calling IXLLSTC in AR-mode, SYSSTATE ASCENV=AR must be issued before the IXLLSTC macro.
8	xxxx0867	Equate Symbol: IXLRSNCODEBADBUFLIST Meaning: Program error. The 128-byte storage area specified by BUFLIST is not addressable. Action: Ensure that the address specified by BUFLIST is valid.
8	xxxx0880	Equate Symbol: IXLRSNCODEBADMOSVECTOR Meaning: Program error. The storage area specified by MOSVECTOR is not addressable. Action: Ensure that: The correct storage area address was used. If you are running in AR-mode and the MOSVECTOR was specified using explicit register notation, the corresponding access register was updated appropriately. If you are calling IXLLSTC in AR-mode, SYSSTATE ASCENV=AR must be issued before the IXLLSTC macro.
8	xxxx0891	Equate Symbol: IXLRSNCODEBADKEYRANGEEND Meaning: Program error. The specified KEYRANGEEND value is not valid. The value of KEYRANGEEND must be greater than or equal to the value of KEYRANGESTART. Action: Ensure that the value specified by KEYRANGEEND is valid.
8	xxxx0892	Equate Symbol: IXLRSNCODEBADKRNOTEMPTY Meaning: Program error. The specified KRNOTEMPTY value is not valid. The value of KRNOTEMPTY must be greater than or equal to the value of KREMPTY. Action: Ensure that the value specified by KRNOTEMPTY is valid.
8	xxxx0893	Equate Symbol: IXLRSNCODEBADLISTNOTEMPTY Meaning: Program error. The specified LISTNOTEMPTY value is not valid. The value of LISTNOTEMPTY must be greater than or equal to the value of LISTEMPTY. Action: Ensure that the value specified for LISTNOTEMPTY is greater than or equal to the value of LISTEMPTY.
8	xxxx0897	Equate Symbol: IXLRSNCODEBADKEYTYPE Meaning: Program error. The specified KEYTYPE value is not suitable for the structure. KEYTYPE=SECONDARY is valid only if the structure supports secondary keys. KEYTYPE=ENTRY is valid only if the structure supports entry keys. Action: Correct the value of KEYTYPE.
8	xxxx08AD	Equate Symbol: IXLRSNCODEBADHIGHSHAREDVIRT Meaning: Program error. The request specified a high shared virtual storage area (above 2GB). Action: None required.
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	xxxx0C17	Equate Symbol: IXLRSNCODESTRFULL Meaning: Environmental error. The MONITOR_SUBLIST or MONITOR_SUBLISTS request attempted to create a new event monitor controls (EMC) object, but the structure is full and cannot accommodate any more EMCs. For a MONITOR_SUBLISTS request, the index of the IXLYMSRI entry that experienced the structure full condition is returned in the answer area. Action: Determine why the structure is full. For a MONITOR_SUBLIST request, you should be monitoring the use of EMC objects (LAAMNSL_EMCCNT is the count of EMCs is use when sublist monitoring was established and LAAMNSL_MAXEMCCNT is the maximum number of EMCs for the structure.) Evaluate this data periodically to ensure structure resources are being used efficiently. You might be able to delete existing EMCs to free up space, or, if rebuild is allowed (IXLCONN macro, ALLOWREBLD parameter), rebuild the structure either to make it larger or with a changed EMCSTGPCT to allow more EMCs to be created. For a MONITOR_SUBLISTS request, you should be monitoring the usage of the structure every time a REQUEST=MONITOR_SUBLISTS is done (LAAMNSLS_EMCCNT is the total count of EMCs in use in the list structure and LAAMNSLS_MAXEMCCNT is the maximum number of EMCs for the list structure.). This data should be evaluated periodically to ensure structure resources are being used efficiently. Field LAAMNSLS_FAILINDEX contains the index of the entry in IXLYMSRI that experienced the structure full condition. IXLYMSRI entries prior to LAAMNSLS_FAILINDEX were processed successfully.
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	xxxx0C68	Equate Symbol: IXLRSNCODEBADREQCFLEVEL Meaning: Environmental error. The request type is not permitted for the level of coupling facility in which the target structure is allocated. Action: Either disconnect from the structure (using IXLDISC) or initiate a rebuild of the structure, if allowed (using IXLREBLD) in a coupling facility of the correct CFLEVEL.
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.