Return and Reason Codes

When the IXLRT macro returns control to your program:

GPR 15 (and retcode, you coded RETCODE) contains a return code.
GPR 0 (and rsncode, if you coded RSNCODE) contains a reason code if applicable.

Macro IXLRT 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 identifies the hexadecimal return and reason codes and the equate symbol associated with each reason code.

Table 1. Return and Reason Codes for the IXLRT Macro
Hexadecimal Return Code	Hexadecimal Reason Code	Equate Symbol Meaning and Action
0	None.	Meaning: IXLRT request successful. Action: None.
4	xxxx0409	Equate Symbol: IXLRSNCODETIMEOUT Meaning: A READALL, READBYCONN, DELETEBYCONN, or DELETENTRYLST request has completed prematurely due to a model-dependent time-out condition. The number of reliable record data entries that has been read or deleted has been returned in the answer area. All other request types: Not applicable. Action: Respecify the request by issuing it with the RESTOKEN, EXTRESTOKEN, or FASTRESTOKEN returned for READALL, READBYCONN, and DELETEBYCONN, or by adjusting FIRSTELEM on a DELETENTRYLST 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. For more information about premature request completion, see z/OS MVS Programming: Sysplex Services Guide.
4	xxxx040F	Equate Symbol: IXLRSNCODEBUFFERFULL Meaning: A READALL or READBYCONN request has completed prematurely due to a buffer full condition. The number of reliable record data entries that have been read has been returned in the answer area. All other request types: Not applicable. Action: Reissue the request specifying RESTOKEN, EXTRESTOKEN, or FASTRESTOKEN and an empty DATAREA. 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 request completion, see z/OS MVS Programming: Sysplex Services Guide.
8	xxxx0801	Equate Symbol: IXLRSNCODEBADPARMLIST Meaning: Program error. The parameter list is either not addressable or not accessible. Action: Verify that the parameter list address is valid.
8	xxxx0804	Equate Symbol: IXLRSNCODEBADVERSION# Meaning: The version number in the parameter list is 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	xxxx0807	Equate Symbol: IXLRSNCODENOTENABLED Meaning: Program error. Caller is not enabled. Action: Verify that the program is enabled for I/O and external interrupts.
8	xxxx080A	Equate Symbol: IXLRSNCODEBADCONTOKEN Meaning: Invalid CONTOKEN specified. The contoken is invalid for one of the following reasons: disconnect has occurred, EOT of the connector's task, input contoken is not the contoken returned from IXLCONN, the request was issued outside the connector's address space, or the contoken has been invalidated for rebuild. Action: Verify that the CONTOKEN value specified is valid and for the correct structure.
8	xxxx080B	Equate Symbol: IXLRSNCODEBADCONNAME Meaning: Program error. The TCONNAME or VERCONNAME specified was not valid. Action: Ensure that the TCONNAME or VERCONNAMEwas specified correctly.
8	xxxx080E	Equate Symbol: IXLRSNCODEBADAREA Meaning: Program error. The answer area specified by ANSAREA is either not addressable or not accessible. Action: Ensure that the address specified for ANSAREA is valid.
8	xxxx0816	Equate Symbol: IXLRSNCODENORTEXISTS Meaning: Program error. There are no record data entries allocated. Action: Ensure that RECORD=YES was specified on the IXLCONN macro to provide recording.
8	xxxx0818	Equate Symbol: IXLRSNCODENOTLOCKSTR Meaning: Program error. The connection specified by CONTOKEN does not represent a lock structure. Action: Verify that the CONTOKEN is specified correctly and is for the correct structure.
8	xxxx081A	Equate Symbol: IXLRSNCODENORTENTRY Meaning: Program error. A request to read, update, or delete a record data entry found no such entry allocated. Action: Verify that the record data entry specified is correctly identified.
8	xxxx082B	Equate Symbol: IXLRSNCODEBADIDINDEX Meaning: Program error. A DELETEENTRYLIST request had an invalid index specified, either by FIRSTELEM or LASTELEM, for the first or last element in the element list. The RTAADELCNT and RTAAFAILINDEX fields in the RTAA will contain the count of elements deleted and the index of the failing entry, respectively. Action: Update FIRSTELEM to point past the failing entry and re-issue the request.
8	xxxx0835	Equate Symbol: IXLRSNCODEBADDATAADDR Meaning: Program error. The storage area specified by DATAREA or ENTRYIDLIST is not addressable. Action: Ensure that the address specified for DATAREA or ENTRYIDLIST is valid.
8	xxxx083D	Equate Symbol: IXLRSNCODEBADANSLEN Meaning: Program error. The length of the answer area, as specified by ANSLEN, is not sufficient for providing answer area information. Action: Determine the length of the answer area and correct the value specified in ANSLEN.
8	xxxx0849	Equate Symbol: IXLRSNCODEBADRESTOKEN Meaning: Program error. A READALL, READBYCONN, or DELETEBYCONN request specified a restart token that was not valid. Possible causes are: The specified token does not correspond to a previous prematurely-completed request. The user specified RESTOKEN when EXTRESTOKEN was required. The user specified EXTRESTOKEN when RESTOKEN was required. All other request types: Not applicable. Action: Ensure that you specified the correct restart token and that you have not modified it.
8	xxxx0855	Equate Symbol: IXLRSNCODEENTRIESCHANGED Meaning: Program error. The record table entry that was represented by the FASTRESTOKEN was deleted or reacquired between IXLRT REQUEST=READBYCONN FASTPATH=YES requests. Action: The request cannot be processed. Reset the value of FASTRESTOKEN to zero and restart the IXLRT process from the beginning.
8	xxxx0887	Equate Symbol: IXLRSNCODEBADEXTRESTOKEN Meaning: Program error. A READALL, READBYCONN, or DELETEBYCONN request specified an extended restart token that was not valid. The specified token refers to an older instance of the target structure. All other request types: Not applicable. Action: Reset the value of EXTRESTOKEN to zero and resubmit the IXLRT request.
8	xxxx08A8	Equate Symbol: IXLRSNCODEBADMRTDLEVEL Meaning:Program error. The value specified for MRTDLEVEL was not valid. Action: Correct your program so that it specifies a valid value for MRTDLEVEL.
C	xxxx0C06	Equate Symbol: IXLRSNCODENOCONN Meaning: Environmental error. No connectivity to structure containing record data. This may occur due to operator commands such as VARY PATH OFFLINE or CONFIG CHP OFFLINE or hardware errors such as coupling facility or path failures. The contoken will be invalidated. Action: Disconnect from the structure or rebuild.
C	xxxx0C0B	Equate Symbol: IXLRSNCODERTFULL Meaning: The record portion of the lock structure is full and cannot accommodate the CREATENTRY request. All other request types: Not applicable. Action: Rebuild or alter the structure to allow for more record data entries.
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	xxxx0C25	Equate Symbol: IXLRSNCODESTRFAILURE Meaning: Environmental error. Prior to the completion of the request, the lock structure failed. Action: Attempt to rebuild the structure using IXLREBLD or disconnect from the structure using IXLDISC.
C	FFFFFFFF	Meaning: XES functions are not available. This can occur because the coupling facility hardware necessary to provide XES function is not present. Action: Re-IPL the system, or follow your particular management protocol.
10	xxxx10xx	Meaning: Failure in XES processing. The state of the resource request is unpredictable. Action: Save the reason code information and contact the IBM® support center.