Return and Reason Codes

When the IXCSETUS 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 IXCSETUS Macro
Hexadecimal Return Code	Hexadecimal Reason Code	Equate Symbol Meaning and Action
00	None.	Meaning: IXCSETUS completed successfully as the caller requested. If the caller specified ECB, the processing is asynchronous; if the caller omitted ECB, the processing is synchronous. Action: None.
04	04	Equate Symbol: IXCSETUSRSNNOCHANGEOLDEQNEW Meaning: Program error. XCF did not change the user state value and did not notify members. If the caller specified OLDUS, XCF returned the current user state value. COMPUS was not specified, and the new value is the same as the current value. Action: None required, because the current user state already matches the desired user state.
04	08	Equate Symbol: IXCSETUSRSNNOCHANGEOLDNECOMPUS Meaning: This return code is informational. COMPUS was specified, and the compare value is not equal to the current value. XCF did not change the user state field and did not notify members. If the caller specified OLDUS, XCF returned the current user state value. Action: None required. The user state should be updated only when the current value matches the COMPUS value. However, if COMPUS is being used to serialize user state updates with other user state update requests, you can retry the request with a new user state value based on the OLDUS, and use the OLDUS as the COMPUS value.
08	04	Equate Symbol: IXCSETUSRSNNOTACTIVE Meaning: Program error. The caller's 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 placed 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: IXCSETUSRSNINAPPROPRIATEPRIMARY Meaning: Program error. The primary address space is not the same as the primary address space of the caller of the IXCJOIN that placed the calling member in the active state. Action: Ensure that the correct MEMTOKEN was specified. Change your program to issue IXCSETUS from the same primary address space as the primary address space of the caller of the IXCJOIN that placed the calling member in the active state.
08	0C	Equate Symbol: IXCSETUSRSNTARGETDIFFERENTGROUP Meaning: Program error. The calling member and the target member are not members of the same XCF group. Action: Take one or more of the following actions: Ensure that the correct TARGET and MEMTOKEN member tokens were specified. Correct your program so that the member updating the user state updates only the user state of members within the same group.
08	10	Equate Symbol: IXCSETUSRSNTARGETNOTVALID Meaning: Program error. The target member's token is not valid. Action: Correct the target member token, and retry the request.
08	14	Equate Symbol: IXCSETUSRSNOLDUSALETNOTPRIMARY Meaning: Program error. The caller specified ECB and OLDUS, and is running in AR mode. However, the ALET that qualifies the address of the OLDUS field is not primary. If you specify ECB, the request completes asynchronously; therefore, the ALET for the OLDUS must be primary, and the OLDUS address must be in common storage. See the requirements for the OLDUS keyword. Action: Ensure that: You specified SYSSTATE ASCENV=AR before issuing the IXCSETUS macro. The ALET of the OLDUS field is zero (primary address space ALET).
08	18	Equate Symbol: IXCSETUSRSNOLDUSBADSTGNOTCOMMON Meaning: Program error. The caller specified ECB and OLDUS; however, the OLDUS field is not in common storage. Action: Ensure that the correct OLDUS field address was used, and that the field is in common storage.
08	28	Equate Symbol: IXCSETUSRSNOLDUSBADALET Meaning: Program error. The caller specified OLDUS, but provided an inappropriate ALET. The ALET is neither zero nor associated with a valid public entry on the caller's DU-AL. Action: Ensure that: You specified SYSSTATE ASCENV=AR before issuing the IXCSETUS macro. The ALET is a public entry on the DU-AL or zero (primary address space ALET). Your program is not intended to run in primary ASC mode.
08	3C	Equate Symbol: IXCSETUSRSNOLDUSINCOMPLETE Meaning: Program error. The caller specified OLDUS incorrectly. The user state might or might not have been updated. Check the two high-order bytes of this reason code fullword xxyy003C for the return code xx (either 00 or 04) and reason code yy the caller would have received if the caller had coded those parameters correctly. Action: Take one or more of the following actions: Ensure that the correct OLDUS address was used. If your program is running in AR mode: Ensure that you specified SYSSTATE ASCENV=AR before issuing the IXCSETUS macro. Ensure that the OLDUS ALET is correct. Ensure that the OLDUS storage area was not inadvertently freed by your program. You might want to abnormally end your program or take some other action that will record the problem with your OLDUS storage area.
08	40	Equate Symbol: IXCSETUSRSNPLISTRSVDNOTVALID 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: IXCSETUSRSNPLISTBADALET Meaning: Program error. Your program is running in primary ASC 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 before issuing the IXCSETUS macro. The ALET for the parameter list is on the DU-AL or is zero (primary address space ALET).
08	104	Equate Symbol: IXCSETUSRSNPLISTVERSIONNOTVALID Meaning: Program error. A 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: IXCSETUSRSNPLISTBADFUNCTION 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: IXCSETUSRSNPLISTBADSTG 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 IXCSETUS macro. Ensure that the parameter list ALET is correct.
08	110	Equate Symbol: IXCSETUSRSNNEWUSNOTACCESSIBLE Meaning: Program error. XCF could not access the NEWUS value. Action: Take one or more of the following actions: Ensure that the correct NEWUS address was used. If your program is running in AR mode: Ensure that you specified SYSSTATE ASCENV=AR before issuing the IXCSETUS macro. Ensure that the NEWUS ALET is correct.
08	114	Equate Symbol: IXCSETUSRSNUSLENBADVALUE Meaning: Program error. The length value in USLEN is less than 1 or greater than 32. Action: Correct the USLEN, and retry the request.
08	118	Equate Symbol: IXCSETUSRSNNOTTASKMODE Meaning: Program error. The caller is not in task mode. Action: Correct your program so that it issues IXCSETUS only while in task mode.
08	11C	Equate Symbol: IXCSETUSRSNNOTENABLED Meaning: Program error. The caller is not enabled. Action: Correct your program so that it issues IXCSETUS only while enabled.
08	124	Equate Symbol: IXCSETUSRSNCOMPUSNOTACCESSIBLE Meaning: Program error. XCF could not access the COMPUS value. Action: Take one or more of the following actions: Ensure that the correct COMPUS address was used. If your program is running in AR mode: Ensure that you specified SYSSTATE ASCENV=AR before issuing the IXCSETUS macro. Ensure that the COMPUS ALET is correct.
0C	18	Equate Symbol: IXCSETUSRSNTASKABENDED Meaning: Environmental error. While the issuing task was suspended for XCF processing, the task was abended; that is, another unit of work attempted to abnormally terminate this task. The state of the IXCSETUS request is unpredictable. Action: Determine why this task was abended.
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.