Return and Reason Codes

When the IXLLOCK macro returns control to your program:

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

Macro IXLYCON 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 IXLLOCK Macro
Hexadecimal Return Code	Hexadecimal Reason Code	Equate Symbol Meaning and Action
0	None.	Meaning: IXLLOCK request successful. For an OBTAIN or ALTER request, ownership has been granted in the requested state. User data is the same as requested. For a RELEASE request specifying MODE=SYNCSUSPEND or MODE=SYNCEXIT, processing is complete. For a RELEASE request specifying MODE=NORESPONSE, the request has been accepted. For a PROCESSMULT request, all LRB processing is complete. Individual return and reason codes are returned for each LRB. Action: None.
4	xxxx0402	Equate Symbol: IXLRSNCODEASYNCH Meaning: Request will be completed asynchronously. If MODE=SYNCEXIT or MODEVAL=IXLMODESYNCEXIT was specified, the system reports request completion through the connected user's COMPLETE exit. For IXLLOCK RELEASE and IXLLOCK PROCESSMULT requests that specified MODE=NORESPONSE or MODEVAL=IXLMODENORESPONSE, request completion is not reported to the connected user. Action: If you specified MODE=SYNCEXIT, the user's complete exit will be given control when the request is complete.
4	xxxx0418	Equate Symbol: IXLRSNCODENOELEMENTTOKEEP Meaning: The IXLLOCK RELEASE request is successful. The user specified to keep the record data entry associated with the resource, but there was no data entry to keep. Action: None expected. However, if you were expecting a record data entry to be present, determine why it was not.
4	xxxx0419	Equate Symbol: IXLRSNCODENOUPDATEONKEEP Meaning: The IXLLOCK RELEASE request is successful. The user specified to keep the associated record data entry and update its contents. The element was kept, but its contents were unable to be updated. Action: Consider using IXLRT to update the contents of the record data entry.
4	xxxx0424	Equate Symbol: IXLRSNCODENODELETEONRELEASE Meaning: The IXLLOCK RELEASE request is successful. The user specified to delete the associated record data entry, but the entry was unable to be deleted. Action: None expected.
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: IXLRSNCODEBADVERSION# Meaning: Program error. The version number in the parameter is not valid. This usually indicates that the level of the macro is incompatible with the level of the XES service code. Action: Verify that your program was assembled with the correct macro library for the release of MVS™ that your program is running on.
8	xxxx0807	Equate Symbol: IXLRSNCODENOTENABLED Meaning: Caller was not enabled. Action: Verify that the program is enabled for I/O and external interrupts.
8	xxxx080A	Equate Symbol: IXLRSNCODEBADCONTOKEN Meaning: Program error. The input contoken is not valid. The contoken may no longer be valid 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	xxxx0810	Equate Symbol: IXLRSNCODERESOURCENOTFOUND Meaning: Program error. Resource specified on ALTER or RELEASE request is not owned or pending ownership. Note that this condition can occur when the request to obtain ownership failed or was denied by the contention exit of the connected user who has been selected to manage the resource contention. Action: Retry request to gain (OBTAIN) ownership of the resource.
8	xxxx0812	Equate Symbol: IXLRSNCODEALREADYOWNED Meaning: Program error. Resource specified on OBTAIN request is already owned. Action: Check protocol to determine why duplicate request for resource has been issued.
8	xxxx0813	Equate Symbol: IXLRSNCODEALREADYPENDING Meaning: Program error. Resource specified on OBTAIN request is already pending ownership. Action: Check protocol to determine why duplicate request for resource has been issued.
8	xxxx0816	Equate Symbol: IXLRSNCODENORTEXISTS Meaning: Program error. A request to WRITE or REACQUIRE a record data entry was unable to be processed due to recording not being active in the lock structure indicated by the input contoken. For recording to be active, the first user to connect to the lock structure must have specified RECORD=YES on its IXLCONN invocation. Action: In order for recording to become active, that structure would have to be deleted and reallocated with RECORD=YES.
8	xxxx0817	Equate Symbol: IXLRSNCODEBADCONID Meaning: Program error. The request to conditionally reacquire an existing record data entry based on the connection with which it is associated has failed. The record data entry to be reacquired was not associated with the connection indicated by the input CONID keyword. Action: Verify that the CONID value was specified correctly.
8	xxxx0818	Equate Symbol: IXLRSNCODENOTLOCKSTR Meaning: Program error. The contoken specified does not represent a lock structure. Action: Verify that the CONTOKEN is specified correctly and is for the intended structure.
8	xxxx0844	Equate Symbol: IXLRSNCODEBADID Meaning: Program error. The attempt to REACQUIRE an existing record data entry has failed because the input ENTRYID does not designate an existing record data entry. Action: Verify that the ENTRYID is specified correctly.
8	xxxx0876	Equate Symbol: IXLRSNCODEBADREQNUM Meaning: Program error. The REQNUM value specified on IXLLOCK REQUEST=PROCESSMULT is not valid. The value must be between 1 and 128 inclusive. Processing is halted with no entries in the REQBUFFER having been processed. Action: Verify that the REQNUM value is specified correctly.
8	xxxx0877	Equate Symbol: IXLRSNCODEBADLRBTYPE Meaning: Program error. A lock request block (LRB) that is input on an IXLLOCK REQUEST=PROCESSMULT request contains a value in the LRB_XTYPE field that is not valid. Action: Verify that the LRB_XTYPE field contains the value of LRB_XTYPE_RELEASEVERS0. If specified, the REQPROC field contains the number of LRBs processed before this error was encountered when the PROCESSMULT request is completed synchronously.
8	xxxx0878	Equate Symbol: IXLRSNCODEBADREQBUFFER Meaning: Program error. An error occurred while XES was attempting to access the storage area defined by REQBUFFER. The number of LRBs processed is returned in the REQPROC field if specified. Action: An error occurred while XES was attempting to access the storage area defined by REQBUFFER. The number of LRBs processed is returned in the REQPROC field if specified and the PROCESSMULT request completed synchronously.
8	xxxx0879	Equate Symbol: IXLRSNCODEBADMODEVAL Meaning: Program error. The value specified for MODEVAL is not valid. Action: Verify that the value specified for MODEVAL is one of the possible mode value constants provided in the IXLYCON macro and that it is a valid value for the type of request being processed. If an LRB contains a mode value that is not supported, the system halts the request. The number of LRBs processed prior to the error is returned in the REQPROC field when the PROCESSMULT request completes synchronously.
8	xxxx087A	Equate Symbol: IXLRSNCODEBADRNAMELEN Meaning: Program error. The value specified for RNAMELEN is not valid. Action: Verify that the length specified for RNAMELEN is between 1 and 300.
8	xxxx087B	Equate Symbol: IXLRSNCODENOVARRNAME Meaning: Program error. An IXLLOCK request that specified a variable length resource name is not valid because the variable length name attribute is not in effect for the lock structure represented by the input contoken. Specify the variable length name attribute at structure allocation time with the RNAMELEN keyword of the IXLCONN macro. Action: If you want to use variable-length resource names, ensure that the initial IXLCONN invocation to connect to the lock structure specifies RNAMELEN=VAR300.
8	xxxx087C	Equate Symbol: IXLRSNCODEBADSYNCFAILDELAY Meaning: Program error. Program error. The value specified for SYNCFAILDELAY is not valid. Action: Verify that the value specified for SYNCFAILDELAY is one of the possible SYNCFAILDELAY value constants provided in the IXLYCON macro.
C	xxxx0C06	Equate Symbol: IXLRSNCODENOCONN Meaning: Environmental error. There is no connectivity to the lock structure. 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: Either disconnect from the structure using IXLDISC or rebuild the structure using IXLREBLD.
C	xxxx0C0B	Equate Symbol: IXLRSNCODERTFULL Meaning: Environmental error. Record portion of the lock structure is full. Action: If your protocol allows, attempt to rebuild the lock structure or alter its size so that additional record data might be available.
C	xxxx0C0D	Equate Symbol: IXLRSNCODESUPERSEDED Meaning: Environmental error. OBTAIN or ALTER request has been superseded by a more current request for the resource. Action: None expected.
C	xxxx0C0F	Equate Symbol: IXLRSNCODEDENIED Meaning: Environmental error. OBTAIN or ALTER request is not granted. Resource request is denied (cancelled) by a related connected user that is managing the contention environment for the resource. Action: Retry request at a later time.
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	xxxx0C20	Equate Symbol: IXLRSNCODERESOURCESCONSTRAINED Meaning: Environmental error. The amount of inuse storage is above a preestablished threshold. Incoming OBTAIN and ALTER requests will be delayed until sufficient storage is reclaimed to fall below the threshold. Action: Wait until the amount of in use storage falls below the preestablished threshold. This occurs when sufficient resources have been released with subsequent UNLOCK or PROCESSMULT requests. OBTAIN or ALTER requests that cannot be delayed until sufficient storage is reclaimed should be specified with the CRITICALREQUEST option specified (IxllockCriticalRequestYes). Note that specifying this option for a request may cause an abend X'026' to be issued by the XES storage manager.
C	xxxx0C25	Equate Symbol: IXLRSNCODESTRFAILURE Meaning: Environmental error. Prior to completion of the request, the lock structure failed. Action: Attempt to rebuild the structure using IXLREBLD or disconnect from the structure using IXLDISC.
C	xxxx0C4C	Equate Symbol: IXLRSNCODERESOURCENOLONGEROWNED Meaning: Environmental error. An IXLLOCK ALTER or IXLLOCK RELEASE request for a resource failed because the resource is no longer owned. Action: Check your protocol to determine why the resource is no longer owned.
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	xxxx0C69	Equate Symbol: IXLRSNCODENODELAY Meaning: Environmental error. An IXLLOCK request in which the user specified MODE=SYNCFAIL encountered a delay. The request is cancelled. Action: Retry request at a later time.
C	FFFFFFFF	Equate Symbol: IXLRSNCODENOTAVAILABLE Meaning: XES functions are not available. This can 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: Failure in XES processing. The state of the involved structure and the disposition of the request are unpredictable. Action: Save the reason code information and contact the IBM® support center.