Return and Reason Codes

When the IXCCREAT 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 IXCCREAT Macro
Hexadecimal Return Code	Hexadecimal Reason Code	Equate Symbol Meaning and Action
00	None.	Meaning: IXCCREAT completed successfully; XCF places member information in the ANSAREA. Action: None.
04	00	Equate Symbol: IXCCREATRSNFIRSTMEMBER Meaning: This is the first member XCF is defining in the group; XCF places member information in the ANSAREA. Action: None.
08	04	Equate Symbol: IXCCREATRSNALREADYCREATED Meaning: Program error. The member already exists in a created state. Action: None required. However, if your program did not expect this return code, you might want to do one of the following: Choose a different unique name for your new member. Use the IXCDELET service to delete the current instance of the member, and then reissue the IXCCREAT service to create a new instance of the member. XCF will assign a unique MEMTOKEN to the new instance. Use the IXCSETUS service to update the member's user state.
08	08	Equate Symbol: IXCCREATRSNISACTIVE Meaning: Program error. The member already exists in an active state. Action: None required. However, if you did not expect this return code, you might want to do one of the following: Choose a different unique name for your new member. Use the IXCLEAVE service to remove the current instance of the member, and then reissue the IXCCREAT service to create a new instance of the member. XCF will assign a new unique MEMTOKEN to the new instance.
08	0C	Equate Symbol: IXCCREATRSNISQUIESCED Meaning: Program error. The member already exists in a quiesced state. Action: None required. However, if you did not expect this return code, you might want to do one of the following: Choose a different unique name for your new member. Use the IXCDELET service to delete the current instance of the member, and then reissue the IXCCREAT service to create a new instance of the member. XCF will assign a new unique MEMTOKEN to the new instance.
08	10	Equate Symbol: IXCCREATRSNISFAILED Meaning: Program error. The member already exists in a failed state. Action: None required. However, if you did not expect this return code, you might want to do one of the following: Choose a different unique name for your new member. Use the IXCDELET service to delete the current instance of the member, and then issue the IXCCREAT service again to create a new instance of the member. XCF will assign a new unique MEMTOKEN to the new instance.
08	14	Equate Symbol: IXCCREATRSNGRPNAMEBAD Meaning: Program error. The group name is not valid. Action: Correct the group name, and retry the request.
08	18	Equate Symbol: IXCCREATRSNMEMNAMEBAD Meaning: Program error. The member name is not valid. Action: Correct the member name, and retry the request.
08	3C	Equate Symbol: IXCCREATRSNANSAREAINCOMPLETE Meaning: Program error. The caller specified ANSAREA or ANSLEN incorrectly. Even though the member might have been placed in a created state, the ANSAREA was nonaddressable or the ANSLEN was not large enough. Action: 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. Take action as described by the corresponding return and reason code. You might want to abnormally end your program or take some other action that will record the problem. You should correct your program to ensure that the ANSAREA is addressable and that the ANSLEN is large enough. See the description of these keywords for their requirements. If the return and reason code indicate that the member was placed in a created state, you can use the IXCQUERY service to get the information that would have been returned in the ANSAREA. Note: You should specify a member name or a unique user state value on the IXCCREAT invocation. If you request to have XCF define the member name, you might not be able to use the IXCQUERY macro to determine which member was created on your behalf.
08	40	Equate Symbol: IXCCREATRSNPLISTRSVDNOTVALID 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: IXCCREATRSNPLISTBADALET Meaning: Program error. Your program is not 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: Your program was not intended to run in primary ASC mode. You specified SYSSTATE ASCENV=AR prior to issuing the IXCCREAT macro. The ALET for the parameter list is a valid public entry on the DU-AL or zero (primary address space ALET).
08	104	Equate Symbol: IXCCREATRSNPLISTVERSIONNOTVALID 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: IXCCREATRSNPLISTBADFUNCTION Meaning: Program error or environmental 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, and that it was assembled with the correct macro library for the release of MVS your program is running on.
08	10C	Equate Symbol: IXCCREATRSNPLISTBADSTG 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 IXCCREAT 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: IXCCREATRSNUSTATEBADSTG 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 IXCCREAT 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: IXCCREATRSNUSLENBADVALUE 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: IXCCREATRSNNOTTASKMODE Meaning: Program error. The caller is not in task mode. Action: Correct your program so that it issues IXCCREAT only while in task mode.
08	11C	Equate Symbol: IXCCREATRSNNOTENABLED Meaning: Program error. The caller is not enabled. Action: Correct your program so that it issues IXCCREAT only while enabled.
0C	04	Equate Symbol: IXCCREATRSNMAXGROUPS Meaning: Environmental error. Your request would have created the first member in a new XCF group. The new group could not be created because the maximum number of groups as defined by the current couple data set already exists. Action: Retry the request at least once. If the problem persists, consult your system programmer to determine if the number of groups defined in the couple data set should be increased, or if the XCF limit on the number of groups has been reached. Your application should cover cases in which the couple data set has no available room. Before running or installing your application, you should make the system programmer aware of your XCF group and member resource requirements.
0C	08	Equate Symbol: IXCCREATRSNMAXMEMBERS Meaning: Environmental error. The maximum number of members in the group already exists. The maximum number of members per group is defined by the installation when the couple data set is formatted. Action: Retry the request at least once. If the problem persists, consult your system programmer to determine if the maximum number of members defined in the couple data set should be increased, or if the XCF limit on the number of members has been reached. Your application should cover cases in which no room is available within the group. Before running or installing your application, you should make the system programmer aware of your XCF group and member resource requirements.
0C	10	Equate Symbol: IXCCREATRSNPARTITIONING Meaning: Environmental error. The system is being removed from the sysplex, and all IXCCREAT requests are permanently suspended. Action: The action required depends on your application. You might want to prepare your application for system termination. (See “Using the Cross-System Coupling Facility” in z/OS MVS Programming: Sysplex Services Guide.)
0C	14	Equate Symbol: IXCCREATRSNXCFLOCALMODE Meaning: Environmental error. IXCCREAT is not allowed when the system is in XCF-local mode. By default, a member in a created state has permanent status recording. Permanent status recording requires a couple data set in which XCF can retain the member's status. XCF-local mode does not support a couple data set. Action: The action required depends on your application. If XCF-local mode is not supported by your application, you must make the system programmer aware of this requirement. The system programmer will have to ensure that the system is not IPLed in XCF-local mode. Before running or installing your application, you should make the system programmer aware of your XCF group and member resource requirements. See z/OS MVS Programming: Sysplex Services Guide.
0C	18	Equate Symbol: IXCCREATRSNTASKABENDED 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 IXCCREAT request is unpredictable. Action: Determine why this task was being 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.