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 IXLYCAA), 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 the IXLCACHE REQUEST=DELETE_NAMELIST Macro
Hexadecimal Return Code	Hexadecimal Reason Code	Equate Symbol Meaning and Action
0	None.	Meaning: If you specified a MODE value of ASYNCECB, ASYNCEXIT, or ASYNCTOKEN, 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 you specified MODE=SYNCECB, the ECB specified in REQECB will be posted when the request has finished. If you specified MODE=SYNCEXIT, the connection's complete exit will be given control when the request has finished. If you specified MODE=SYNCTOKEN, the REQTOKEN contains an asynchronous request token that may be used on the IXLFCOMP macro to determine when the request has completed. Action: If you specified MODE=SYNCECB, wait on the ECB you specified in REQECB. If you specified MODE=SYNCEXIT, the connection's completion 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 has completed prematurely because the model-dependent time-out criteria of the coupling facility has been exceeded. The index of the next registration block to be processed has been returned in the answer area (field CAARNLINDEX). Action: Reissue the request. 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. The entries that were processed are indexed from STARTINDEX to CAARNLINDEX-1. To restart the request, update STARTINDEX with the value of CAARNLINDEX, the index of the next name element to be processed. For more information about premature request completion, see z/OS MVS Programming: Sysplex Services Guide.
4	xxxx042A	Equate Symbol: IXLRSNCODEHALTCHANGEDDATA Meaning: A DELETE_NAMELIST request with HALTONCHANGED=YES specified was halted due to a structure entry being found to have data in the changed state or having a cast-out lock held. The index of the name block in the element list that met the halt criteria as well as cast-out information for the entry has been returned in the answer area. All prior entries have been processed. Action: Since delete processing was requested to be halted when changed data or data locked for cast-out was encountered, the application should treat the deletion attempt as an error condition and prior to resuming the request, write the data to permanent storage and change the state of the indicated structure entry data to "unchanged" (i.e. the cast-out lock is not held and the status of the data is unchanged) before resuming the request. The index value of the name within the specified list of name blocks that caused the request to be halted has been returned in the answer area. After taking action, the request may be started at the entry that caused the request to halt by setting the STARTINDEX parameter to CAADNLINDEX.
8	xxxx0801	Equate Symbol: IXLRSNCODEBADPARMLIST Meaning: The parameter list (mfctrl) for this request is not addressable. The answer area (ANSAREA) fields are not valid. Action: Verify the parameter list address. The parameter list must be addressable in the caller's primary address space or from the caller's PASN access list. If you are issuing this macro while disabled, the parameter list must reside 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 must be updated appropriately. If you are issuing this macro in AR-mode, SYSSTATE ASCENV=AR must be issued before this macro.
8	xxxx0804	Equate Symbol: 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. Verify that your program is running on an MVS system that supports the version of the macro you are using.
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: Verify that the CONTOKEN value specified was valid and for the correct structure. The numbers on the following actions correspond to the numbers above. Discontinue use. Perform recovery and cleanup for the structure and check protocol for use of structure to determine why you did not know of the disconnection. Discontinue use. Perform recovery and cleanup for the structure and check protocol for use of structure to determine why you did not know that the task ended. Issue IXLCONN to connect to the structure. 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. Participate in the rebuild. When it is complete, try again. Discontinue use. Perform recovery and cleanup for the structure and check protocol for use of structure. You may want to issue IXCQUERY to get more information about the structure.
8	xxxx0819	Equate Symbol: IXLRSNCODEBADVECTOROP Meaning: The vector index in the registration block indexed by CAARNLINDEX is not valid. None of the registration blocks have been processed. All vector indexes for all registration blocks in the buffer have been set to indicate that the local buffer is not valid. Action: Correct the vector index value and reissue the REG_NAMELIST request with the same STARTINDEX and ENDINDEX values.
8	xxxx0824	Equate Symbol: IXLRSNCODEWRONGSTRTYPE Meaning: The connect token specified by CONTOKEN is not to a cache structure. Action: Verify the connect token for this cache structure. Note: The connect token can be found in the IXLCONN answer area. Verify the value specified on the TYPE= parameter of the IXLCONN request for this structure.
8	xxxx082D	Equate Symbol: IXLRSNCODEBADSTGCLASS Meaning: Program error. A REG_NAMELIST registration block specified a storage class value that exceeded the maximum defined storage class for the structure. CAARNLINDEX contains the index of the registration block that contained the storage class value in error. All registration blocks preceding this block were processed. Action: Correct the storage class value in the registration block indexed by CAARNLINDEX and reissue the REG_NAMELIST request starting with that registration block.
8	xxxx0833	Equate Symbol: IXLRSNCODEBADPGBLATTR Meaning: Program error. The storage area specified by BUFFER is specified as being pageable (PAGEABLE=YES) but is not. Action: Change the buffer area 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 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 the caller is running in AR-mode and the BUFFER parameter was specified using explicit register notation, the corresponding access register was updated appropriately.
8	xxxx0835	Equate Symbol: IXLRSNCODEBADDATAADDR Meaning: Program error. The storage area specified by BUFFER is not addressable. All bits in the local cache vector may be reset to overindicate that the data items are not valid. Action: Ensure that: The correct buffer address was used for BUFFER. 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. The buffer area is addressable in the caller's primary address space or from the caller's PASN access list. If the caller is running in AR-mode and the BUFFER parameter was specified using explicit register notation, the corresponding access register was updated appropriately. If the caller is running in AR-mode, SYSSTATE ASCENV=AR must be specified before issuing this macro.
8	xxxx0838	Equate Symbol: IXLRSNCODEBADANSAREA Meaning: Program error. The storage area specified by ANSAREA is not addressable. Action: Verify the ANSAREA address. ANSAREA must be addressable in the caller's primary address space or from the caller's PASN access list. If you are calling IXLCACHE while disabled, ANSAREA must reside in either page-fixed or DREF storage. If you are calling IXLCACHE in AR-mode and you specified the ANSAREA address using explicit register notation, the corresponding access register must be updated appropriately. If you are calling IXLCACHE in AR-mode, SYSSTATE ASCENV=AR must be issued before the IXLCACHE 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: Verify the REQTOKEN address. If you are calling IXLCACHE while disabled, REQTOKEN must reside in either page-fixed or DREF storage. If you are calling IXLCACHE in AR-mode and you specified the REQTOKEN address using explicit register notation, the corresponding access register must be updated appropriately. If you are calling IXLCACHE in AR-mode, SYSSTATE ASCENV=AR must be issued before the IXLCACHE 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 provided for the request, and rerun your program. Depending on the macro version number, specify the length of the answer area as follows: CAALEVEL0LEN indicates the level 0 mapping of the answer area. CAALEVEL1LEN indicates the level 1 mapping of the answer area. IXLCACHE macro invocations at the version 4 and higher level require an answer area length of CAALEVEL1LEN.
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	xxxx0865	Equate Symbol: IXLRSNCODEBADBUFSPEC Meaning: Program error. There is an error in the buffer specification. Action: Check the following: Requirements for BUFFER and BUFSIZE. Buffer boundaries.
8	xxxx0866	Equate Symbol: IXLRSNCODEBADBUFKEY Meaning: Program error. The buffer storage key specified by BUFSTGKEY is incorrect or BUFSTGKEY was not specified and the PSW key does not match the key of the buffers. The data cannot be stored in 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 IXLCACHE in AR-mode, SYSSTATE ASCENV=AR must be issued before the IXLCACHE macro.
8	xxxx0874	Equate Symbol: IXLRSNCODEBADRNLINDEX Meaning: Program error. Either the value specified for either STARTINDEX or ENDINDEX is not valid or the size of the buffer specified by BUFFER is smaller than required based on the value of ENDINDEX. Action: Ensure that: The values specified by STARTINDEX and ENDINDEX are in the range of 1 to 32. The value specified by ENDINDEX is greater than or equal to the value of STARTINDEX. The value specified by ENDINDEX does not imply a larger BUFFER size than was actually specified on the REG_NAMELIST request.
8	xxxx0875	Equate Symbol: IXLRSNCODEBADNSBAREA Meaning: Program error. The storage area specified by NSBAREA is not addressable. Action: Ensure that: The address passed in NSBAREA is valid. The NSBAREA area was not previously freed. The NSBAREA area is addressable from the caller's primary address space or from the caller's PASN access list. If the caller is running in AR-mode and NSBAREA was specified using explicit register notation, ensure that the corresponding access register was updated appropriately. If the caller is disabled, then NSBAREA must reside in either nonpageable or disabled reference storage. If your program is running in AR mode, ensure that you specified SYSSTATE ASCENV=AR before issuing the IXLCACHE macro.
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. No connectivity to the cache structure exists. This may occur due to operator commands such as VARY PATH,OFFLINE or CONFIG CHP,OFFLINE or hardware errors such as facility or path failures. The CONTOKEN is invalidated. The request fails. Action: Either disconnect from the structure (using IXLDISC) or initiate a rebuild of the structure, if allowed (using IXLREBLD).
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 Quiesce, Rebuild Stop, or Rebuild Cleanup event. The connector invoked IXLREBLD REQUEST=COMPLETE. 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 IXLCACHE 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.
C	xxxx0C17	Equate Symbol: IXLRSNCODESTRFULL Meaning: Environmental error. Allocation of a directory entry was necessary, but was unavailable or could not be reclaimed. In the answer area, CAASTGCLFULL contains the storage class from which the reclaiming operation failed. CAARNLINDEX contains the index of the registration block that was being processed when the error occurred. All prior registration blocks were processed. Action: Determine if any data items may be cast-out to make room for this item. Check your usage of storage classes to see if some data items can be moved to a different storage class (preferably with a lower priority) so some entries in the structure can be freed. Determine if a rebuild or an alter of the structure is necessary to make room for more data entries/items. After correcting the error, restart the REG_NAMELIST request starting with the registration block indexed by CAARNLINDEX.
C	xxxx0C25	Equate Symbol: IXLRSNCODESTRFAILURE Meaning: Environmental error. The cache structure failed prior to completion of the request. Action: Attempt to rebuild the structure using IXLREBLD, or disconnect from the structure using IXLDISC.
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 continue processing using single READ_DATA requests to perform the function of the REG_NAMELIST request or disconnect from the structure (using IXLDISC) and request that the installation provide a coupling facility of the correct CFLEVEL (CFLEVEL=2 or higher).
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. The coupling facility hardware might not be present. Action: XES may not be used when XCF is running local mode. XES requires that the coupling facility be installed.
10	xxxx10xx	Equate Symbol: IXLRSNCODECOMPERROR Meaning: System error. XES processing failure. The state of the structure and the disposition of the request are unpredictable. The answer area (ANSAREA) fields do not contain valid information. Action: Save the reason code information, and contact the IBM® support center.