z/OS MVS Programming: Sysplex Services Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Return and Reason Codes

z/OS MVS Programming: Sysplex Services Reference
SA38-0658-00

When the IXCJOIN 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 IXCJOIN Macro

Hexadecimal
Return Code

Hexadecimal
Reason Code

Equate Symbol
Meaning and Action

00 None. Meaning: IXCJOIN completed successfully. XCF places the member in the active state, and places member information in ANSAREA.

Action: None.

04 04 Equate Symbol: IXCJOINRSNFIRSTACTIVEMEMBER

Meaning: IXCJOIN completed successfully; the member is the first active member of the group. XCF places member information in ANSAREA.

Action: None required.

04 08 Equate Symbol: IXCJOINRSNWASFAILED

Meaning: IXCJOIN completed successfully; the member already exists in a failed state, and the caller correctly specified LASTING=YES. A new member token has been assigned to the new instance of the member.

Action: None required. However, because the previous instance of the member was in a failed state, your application might need to perform some type of cleanup or takeover processing. MVS™ placed the member in the failed state when the member's corresponding task, address space, or system terminated. If the user state of the previous instance is needed and you must specify a user state on the IXCJOIN request, you can change your program to issue an IXCQUERY prior to the IXCJOIN to capture the user state of the previous instance. If you do not specify a user state on IXCJOIN, the new instance of the member will retain the user state of the old instance.

04 0C Equate Symbol: IXCJOINRSNWASQUIESCED

Meaning: IXCJOIN completed successfully; the member already exists in a quiesced state, and the caller correctly specified LASTING=YES. A new member token has been assigned to the new instance of the member.

Action: None required. However, because the previous instance of the member was in a quiesced state, your application might need to perform some type of cleanup or takeover processing. The previous instance of the member voluntarily placed itself in a quiesced state. If the user state of the previous instance is needed and you must specify a user state on the IXCJOIN request, you can change your program to issue an IXCQUERY prior to the IXCJOIN to capture the user state of the previous instance. If you do not specify a user state on IXCJOIN, the new instance of the member will retain the user state of the old instance.

04 10 Equate Symbol: IXCJOINRSNWASCREATED

Meaning: IXCJOIN completed successfully. The member already exists in a created state, and the caller correctly specified LASTING=YES.

Action: None required. However, you might take some action based on your application. You can use the member's current user state to determine what action needs to be taken.

08 04 Equate Symbol: IXCJOINRSNISCREATED

Meaning: Program error. The member already exists in a created state, and the caller did not specify LASTING=YES. LASTING=YES must be specified since the member already has permanent status recording. The member's state and user state are not altered.

Action: Ensure that your program specifies LASTING=YES, and retry the request. If permanent status recording is not required for this instance of the member, issue IXCDELET to delete the member, and retry the IXCJOIN request.

08 08 Equate Symbol: IXCJOINRSNISACTIVE

Meaning: Program error. The member already exists in an active state.

Action: None required. However, you might take some action depending on your application.

08 0C Equate Symbol: IXCJOINRSNISQUIESCED

Meaning: Program error. The member already exists in a quiesced state, and the caller did not specify LASTING=YES. LASTING=YES must be specified since the member already has permanent status recording. The member's state and user state are not altered.

Action: Ensure that your program specifies LASTING=YES, and retry the request. If permanent status recording is not required for this instance of the member, issue IXCDELET to delete the member, and retry the IXCJOIN request. Before you delete the member, you can use the IXCQUERY service to capture the member's current user state.

08 10 Equate Symbol: IXCJOINRSNISFAILED

Meaning: Program error. The member already exists in a failed state, and the caller did not specify LASTING=YES.

Action: Ensure that your program specifies LASTING=YES, and retry the request. If permanent status recording is not required for this instance of the member, issue IXCDELET to delete the member, and retry the IXCJOIN request. Prior to deleting the member, you can use the IXCQUERY service to capture the member's current user state.

08 14 Equate Symbol: IXCJOINRSNGRPNAMEBAD

Meaning: Program error. The group name is not valid.

Action: Correct the group name, and retry the request.

08 18 Equate Symbol: IXCJOINRSNMEMNAMEBAD

Meaning: Program error. The member name is not valid.

Action: Correct the member name, and retry the request.

08 1C Equate Symbol: IXCJOINRSNINTERVALBAD

Meaning: Program error. The status-checking interval value is zero or is not a multiple of 100.

Action: Correct the status-checking interval, and retry the request.

08 20 Equate Symbol: IXCJOINRSNSTATFLDBADSTG

Meaning: Program error. XCF could not access the STATFLD.

Action: Ensure that the STATFLD parameter is correct. The STATFLD must be a doubleword in fixed or DREF common storage.

08 24 Equate Symbol: IXCJOINRSNLASTINGNEEDSMEMNAME

Meaning: Program error. The caller specified LASTING=YES without specifying the member name. XCF will not generate member names for members that have permanent status recording.

Action: If the member requires permanent status recording, provide a member name. If the member does not require permanent status recording, do not specify LASTING=YES.

08 28 Equate Symbol: IXCJOINRSNSTATUSMONINCOMPLETE

Meaning: Program error. The STATFLD, INTERVAL, or STATEXIT parameter is missing. For XCF to monitor the member's status, all three of these values must be specified.

Action: Ensure that the STATFLD, INTERVAL, and STATEXIT are correct, and retry the request.

08 xxyy003C Equate Symbol: IXCJOINRSNANSAREAINCOMPLETE

Meaning: Program error. The caller specified ANSAREA or ANSLEN incorrectly. Even though the member might have been placed in an active 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 from IXCJOIN 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 an active 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 IXCJOIN invocation. If you request to have XCF define the member name, you might not be able to use IXCQUERY to determine which member was created on your behalf.
08 40 Equate Symbol: IXCJOINRSNPLISTRSVDNOTVALID

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 44 Equate Symbol: IXCJOINRSNMEMASSOCBAD

Meaning: Program error. The member association value (task, address space or job) is not correct in the parameter list.

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: IXCJOINRSNPLISTBADALET

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 is not intended to run in primary ASC mode.
  • You specified SYSSTATE ASCENV=AR before issuing the IXCJOIN macro.
  • The ALET for the parameter list is a valid public entry on the DU-AL or is zero (primary address space ALET).
08 104 Equate Symbol: IXCJOINRSNPLISTVERSIONNOTVALID

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: IXCJOINRSNPLISTBADFUNCTION

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: IXCJOINRSNPLISTBADSTG

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 ASC mode:
    • Ensure that you specified SYSSTATE ASCENV=AR before issuing the IXCJOIN 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: IXCJOINRSNUSTATEBADSTG

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 ASC mode:
    • Ensure that you specified SYSSTATE ASCENV=AR before issuing the IXCJOIN macro.
    • Ensure that the USTATE ALET corresponds to the parameter list address.
  • Ensure that the USTATE storage area was not inadvertently freed by your program.
08 114 Equate Symbol: IXCJOINRSNUSLENBADVALUE

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: IXCJOINRSNNOTTASKMODE

Meaning: Program error. The caller is not in task mode.

Action: Correct your program so that it issues IXCJOIN only while in task mode.

08 11C Equate Symbol: IXCJOINRSNNOTENABLED

Meaning: The caller is not enabled.

Action: Correct your program so that it does not issue IXCJOIN while it is disabled.

08 120 Equate Symbol: IXCJOINRSNPRIMARYNOTHOME

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 IXCJOIN while in cross memory mode. You might want to pass this restriction on to your caller when you are unsure of the environment in which your caller may call your program.

08 128 Equate Symbol: IXCJOINRSNTASKTERM

Meaning: Program error. XCF does not allow the JOIN process during or after task termination.

Action: Correct your program so that it does not issue IXCJOIN from a task that is terminating. Ensure that your application does not invoke IXCJOIN from a task termination resource manager. You might want to pass this restriction on to your caller when you are unsure of the environment in which your caller may call you.

08 12C Equate Symbol: IXCJOINRSNFUNCDESCBAD

Meaning: Program error. The FUNCTION keyword does not specify a valid descriptor (bad character, leading blanks, all blank).

Action: Correct the FUNCTION specification.

0C 04 Equate Symbol: IXCJOINRSNMAXGROUPS

Meaning: Environmental error. The maximum number of groups 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 dataset 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: IXCJOINRSNMAXMEMBERS

Meaning: Environmental error. The maximum number of members in the group already exists.

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: IXCJOINRSNPARTITIONING

Meaning: Environmental error. The system is being removed from the sysplex, and XCF permanently suspends all requests to join a group on this system.

Action: The action is dependent on your application. You might want to prepare your application for system termination. (See the topic on XCF in z/OS MVS Programming: Sysplex Services Guide)

0C 14 Equate Symbol: IXCJOINRSNXCFLOCALMODE

Meaning: Environmental error. IXCJOIN with LASTING=YES is not allowed when the sysplex is in XCF-local mode. 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: This depends on your program. 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.)

10 None. Meaning: System error. XCF processing failed.

Action: Retry the request at least once. If the problem persists, record the return code and reason code, if applicable, and supply them to the appropriate IBM® support personnel.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014