Return and Reason Codes

When the IXCLEAVE 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 IXCYCON provides equate symbols for the return and reason codes. The equate symbols associated with each hexadecimal return code are as follows:

0: IXCRETCODEOK
4: IXCRETCODEWARNING
8: IXCRETCODEPARMERROR
C: IXCRETCODEENVERROR
10: IXCRETCODECOMPERROR

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 IXCLEAVE Macro
Hexadecimal Return Code	Hexadecimal Reason Code	Equate Symbol Meaning and Action
00	None.	Meaning: IXCLEAVE completed successfully. XCF places the member in the not-defined state and informs group members of the change. Action: None.
04	04	Equate Symbol: IXCLEAVERSNEXITSNOTPURGED Meaning: Environmental error. IXCLEAVE completed successfully. XCF did not purge the group, status, or message user-routine SRBs successfully. For a group, status, or message exit, it is possible that the member specified on IXCJOIN is still running. Once an exit returns to XCF, it will not be scheduled again. Action: Your application should be aware that one of the exits might still be running. If this return code occurs more than once for IXCLEAVE, take the following actions: Determine if any asynchronous abends are being issued against the current task. If so, you may need to reduce their frequency. XCF should have taken an SDUMP to record the abend or abends. If the SDUMP indicates that the error was caused by SRB-to-task percolation or application code issuing a CALLRTM against your task, this is probably not an XCF error. If you feel this is an XCF error, record the return and reason code, and supply it to the appropriate IBM® support personnel.
08	04	Equate Symbol: IXCLEAVERSNNOTACTIVE Meaning: Program error. The member token does not identify an active member. Action: Ensure that the correct MEMTOKEN was specified. Further action depends on your application. If the member must be in a not-defined state, you can use the IXCQUERY service to determine what state the member is currently in. If the member is currently in a failed, quiesced, or created state, you can use the IXCDELET service to place the member in a not-defined state.
08	08	Equate Symbol: IXCLEAVERSNINAPPROPRIATEPRIMARY Meaning: Program error. The primary address space is neither the master scheduler address space nor the primary address space of the caller that issued IXCJOIN to place the member in the active state. Action: Ensure that: The correct MEMTOKEN was specified. Your program issues IXCLEAVE only from the master scheduler address space or the address space from which the member (MEMTOKEN) joined the group.
08	10	Equate Symbol: IXCLEAVERSINAPPROPRIATESYSTEM Meaning: Program error. The system is not the system on which the IXCJOIN for the member was issued. Action: Ensure that: The correct MEMTOKEN was specified. Your program issues IXCLEAVE only for members that joined on the same system as your program.
08	40	Equate Symbol: IXCLEAVERSNPLISTRSVDNOTVALID Meaning: Program error or environmental error. A reserved field in the control parameter list is not zero. Action: Check to see if your program inadvertently overlaid the parameter list storage, and that it was assembled with the correct macro library for the release of MVS™ your program is running on.
08	100	Equate Symbol: IXCLEAVERSNPLISTBADALET Meaning: Program error. Your program is running in AR mode, and the ALET that qualifies the address of the control parameter list is neither zero nor associated with a valid public entry on the caller's DU-AL. Action: Ensure that: You specified SYSSTATE ASCENV=AR prior to issuing the IXCLEAVE macro. The ALET for the parameter list is a valid public entry on the DU-AL or is zero (primary address space ALET). Your program is not intended to run in primary ASC mode.
08	104	Equate Symbol: IXCLEAVERSNPLISTVERSIONNOTVALID Meaning: Program error or environmental error. The version number in the control parameter list is not valid. Action: Check to see if your program inadvertently overlaid the parameter list storage, and that it was assembled with the correct macro library for the release of MVS your program is running on.
08	108	Equate Symbol: IXCLEAVERSNPLISTBADFUNCTION Meaning: Program error. The function code in the control parameter list is not valid. Action: Check to see if your program inadvertently overlaid the parameter list storage.
08	10C	Equate Symbol: IXCLEAVERSNPLISTBADSTG Meaning: Program error. XCF could not access the control parameter list. Action: Take one or more of the following actions: Ensure that the correct parameter list storage area was specified. If your program is running in AR mode: Ensure that you specified SYSSTATE ASCENV=AR before issuing the IXCLEAVE macro. Ensure that the parameter list ALET is correct. Ensure that the parameter list storage area was not inadvertently freed by your program.
08	110	Equate Symbol: IXCLEAVERSNUSTATEBADSTG Meaning: Program error. XCF could not access the USTATE value. Action: Take one or more of the following actions: Ensure that the correct USTATE address was specified. If your program is running in AR mode: Ensure that you specified SYSSTATE ASCENV=AR before issuing the IXCLEAVE macro. Ensure that the USTATE ALET is correct. Ensure that the USTATE storage area was not inadvertently freed by your program.
08	114	Equate Symbol: IXCLEAVERSNUSLENBADVALUE Meaning: Program error. The USLEN value is less than 1 or greater than 32. Action: Correct the USLEN, and retry the request.
08	118	Equate Symbol: IXCLEAVERSNNOTTASKMODE Meaning: Program error. The caller is not in task mode. Action: Correct your program so that it issues IXCLEAVE only while in task mode.
08	11C	Equate Symbol: IXCLEAVERSNNOTENABLED Meaning: Program error. The caller is not enabled. Action: Correct your program so that it issues IXCLEAVE only while enabled.
08	120	Equate Symbol: IXCLEAVERSNPRIMARYNOTHOME Meaning: Program error. The primary address space is not equal to the home address space. Action: Correct your program so that it does not use IXCLEAVE while in cross memory mode. You might want to pass this restriction on to your caller when you are unsure of the environment your caller may have been in.
0C	18	Equate Symbol: IXCLEAVERSNTASKABENDED Meaning: Environmental error. While the issuing task was suspended for XCF processing, the task was abended (i.e. another unit of work attempted to abnormally terminate this task). The state of the IXCLEAVE request is unpredictable. Action: Determine why another unit of work has decided to abnormally terminate this task.
10	None.	Meaning: System error. XCF processing failed. Action: Retry the request at least once. If the problem persists, record the return code, and supply it to the appropriate IBM support personnel.