Return and Reason Codes

When the IXCMG 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 IXCMG Macro
Hexadecimal Return Code	Hexadecimal Reason Code	Equate Symbol Meaning and Action
0	None.	Meaning: IXCMG completed successfully, and XCF provided all the data that the caller requested. Action: None.
4	4	Equate Symbol: IXCMGRSNSTILLMOREDATA Meaning: Program error. IXCMG completed successfully, and XCF provided some data; however, DATAAREA is too small to contain all the requested data. Action: Take one or more of the following actions: If the required information is contained in the DATAAREA, no further action needs to be taken. If the required information is not contained in the DATAAREA, obtain a larger DATAAREA and reissue IXCMG. The AMDATLEN field, as defined by the XCF accounting and measurement data area mapping macro (IXCYAMDA), contains the DATAAREA size that is required to contain all of the information that would have been returned. However, because IXCMG returns only a snapshot of the current status, it is possible that the AMDATLEN might be too small on the next invocation. Ensure that you specified the correct length for the data area. Ensure that the parameter list was not inadvertently overlaid. Ensure that you specified the correct data area address and ALET. If your program is not running in primary ASC mode, ensure that you specified SYSSTATE ASCENV=AR.
4	8	Equate Symbol: IXCMGRSNRESULTSPENDING Meaning: For GATHERFROM=TOKEN, the expected results have not yet arrived. DATAAREA was not updated. Action: Try again later.
4	10	Equate Symbol: IXCMGRSNCHECKRESULTS Meaning: GATHERFROM=OTHER might have failed. For GATHERFROM=TOKEN, the request completed successfully, but the data gathering performed by the target system completed with a nonzero return code. For GATHERFROM=OTHER, the local system determined that the target system could not process the request. Action: Check the returned header for the return and reason codes that explain why the target system failed to process the request.
8	14	Equate Symbol: IXCMGRSNDATAAREATOOSMALL Meaning: Program error. DATAAREA field is too small to contain the header (AMDAREA, AMDAGFD or AMDAGFO). Action: Take one or more of the following actions: Provide a data area that is large enough to contain at least the header information as mapped by the field (AMDAREA, AMDAGFD or AMDAGFO) of the XCF accounting and measurement data area mapping macro (IXCYAMDA). Ensure that you specified the correct length for the data area. Ensure that the parameter list was not inadvertently overlaid. Ensure that you specified the correct data area address and ALET. If your program is running in AR mode, ensure that you specified SYSSTATE ASCENV=AR.
8	18	Equate Symbol: IXCMGRSNDATAAREABADSTG Meaning: Program error. XCF could not access DATAAREA. Action: Take one or more of the following actions: Ensure that the correct DATAAREA address, ALET, and length were specified. Ensure that the parameter list storage area was not inadvertently freed by your program. If your program is running in AR mode, ensure that you specified SYSSTATE ASCENV=AR before issuing the IXCMG macro.
8	1C	Equate Symbol: IXCMGRSNBADALET Meaning: Program error. The ALET that qualifies the address specified on DATAAREA is neither zero nor associated with a valid public entry on the caller's DU-AL. Action: Ensure that: If your program is running in AR mode, you specified SYSSTATE ASCENV=AR before issuing the IXCMG macro. The ALET for the parameter list is a valid public entry on the DU-AL or is zero (primary address space ALET).
8	40	Equate Symbol: IXCMGRSNPLISTRSVDNOTVALID Meaning: Program error or environmental error. A reserved field in the control parameter list is not zero. Your program might have inadvertently written over an area in the control 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.
8	100	Equate Symbol: IXCMGRSNPLISTBADALET 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 IXCMG macro. The ALET for the parameter list is a valid public entry on the DU-AL or is zero (primary address space ALET).
8	104	Equate Symbol: IXCMGRSNPLISTVERSIONNOTVALID 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.
8	108	Equate Symbol: IXCMGRSNPLISTBADFUNCTION 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.
8	10C	Equate Symbol: IXCMGRSNPLISTBADSTG 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 IXCMG macro. Ensure that the parameter list ALET is correct. Ensure that the parameter list storage area was not inadvertently freed by your program.
8	110	Equate Symbol: IXCMGRSNPLISTBADAMDALEVEL Meaning: Program error. AMDALEVEL value is not valid. Action: Correct the AMDALEVEL value in the request and try again. The AMDAGFO_MaxAmdaLevel field in the DATAAREA indicates the highest AMDALEVEL supported by the target system. AMDALEVEL must be zero for GATHERFROM=OTHER requests.
8	114	Equate Symbol: IXCMGRSNPLISTBADMEMTOKEN Meaning: Program error. MEMTOKEN value is not a valid member token. Action: Correct the MEMTOKEN value in the request and try again. MEMTOKEN must be zero for GATHERFROM=OTHER requests.
8	118	Equate Symbol: IXCMGRSNPLISTBADSYSID Meaning: Program error. SYSID value is not valid. Action: Correct the SYSID value in the request and try again. SYSID must be zero for GATHERFROM=LOCAL and GATHERFROM=OTHER requests.
8	11C	Equate Symbol: IXCMGRSNNOTENABLED Meaning: Program error. The program must be running enabled when GATHERFROM=TOKEN or when GATHERFROM=OTHER and ECBPTR=ecbptr is requested. Action: Make sure the program is running enabled when making the request.
8	120	Equate Symbol: IXCMGRSNPLISTBADREQTOKEN Meaning: Program error. REQTOKEN value is not a valid token. Action: Correct the REQTOKEN value in the request and try again. REQTOKEN must be zero for GATHERFROM=LOCAL requests.
8	124	Equate Symbol: IXCMGRSNPLISTBADTIMEOUT Meaning: Program error. TIMEOUT value is not valid. Action: Correct the TIMEOUT value in the request and try again. The TIMEOUT value must be in the range of 1 to 120, inclusive. Nonzero TIMEOUT value should only be used for GATHERFROM=OTHER requests.
8	128	Equate Symbol: IXCMGRSNECBBADSTG Meaning: Program error. Unable to access ECB storage. Action: Make sure the ECB storage pointed by ECBPTR=ecbptr is valid.
8	12C	Equate Symbol: IXCMGRSNLOCKHELD Meaning: Environmental error. Caller holds locks when making the request. The program must be running with no lock held when requesting GATHERFROM=TOKEN or GATHERFROM=OTHER and ECBPTR=ecbptr. Action: Make sure the program does not hold any locks when making the request.
8	130	Equate Symbol: IXCMGRSNPLISTBADGROUP Meaning: Program error. GROUP value is not valid. Action: Correct the GROUP value in the request and try again. GROUP value must be NO for GATHERFROM=TOKEN requests.
8	134	Equate Symbol: IXCMGRSNPLISTBADECBPTR Meaning: Program error. ECBPTR value is not valid. Action: Correct the ECBPTR value in the request and try again. A nonzero ECBPTR value should only be used for GATHERFROM=OTHER requests.
8	138	Equate Symbol: IXCMGRSNPLISTBADTYPE Meaning: Program error. TYPE value is not valid. Action: Correct the TYPE value in the request and try again. The default value (TYPE=ALL) must be used for GATHERFROM=TOKEN requests.
C	4	Equate Symbol: IXCMGRSNNEEDSOFTWARE Meaning: Environmental error. The system is unable to process the request because it does not have the necessary software installed. For example, the target system does not support GATHERFROM=OTHER requests. Action: Make sure the system from which the data is to be gathered has the necessary level of software installed.
C	8	Equate Symbol: IXCMGRSNNEEDRESOURCES Meaning: Environmental error. The request could not be processed because the system was unable to obtain the resources needed to process the request. Action: Make sure the system from which the data is to be gathered has enough resources to process the request. Be aware that the amount of data collected when TYPE=ALL is specified could be quite large. You might want to use separate requests to collect different TYPEs of data instead.
C	C	Equate Symbol: IXCMGRSNSYSTEMNOTACTIVE Meaning: Environmental error. The system that is to provide the requested data is unable to do so because it is not active in the sysplex. For GATHERFROM=OTHER request, the local system was able to make this determination before the request was accepted for processing. For GATHERFROM=TOKEN request, the local system made this determination after the GATHERFROM=OTHER request was accepted but the system became inactive before the data could be made available to the local system. Action: As appropriate, try again after the target system becomes active to obtain the desired data.
C	10	Equate Symbol: IXCMGRSNSYSTEMNOTREADY Meaning: Environmental error. For GATHERFROM=OTHER, the local system and the target system have not yet completed the setup needed to process the request. Action: Try again later.
C	14	Equate Symbol: IXCMGRSNNEEDNEWREQUEST Meaning: Environmental error. For GATHERFROM=TOKEN, the request indicated by REQTOKEN no longer exists. Action: As appropriate, issue a new GATHERFROM=OTHER request to obtain the desired data. Because this failure likely implies that the request timed out, consider increasing the TIMEOUT specification for the new request. If you have coded the maximum possible timeout, there might be system problems that prevent your GATHERFOM=TOKEN request from being processed in a timely manner, or that prevent XCF from being able to collect the data from the target system in a timely manner.
10	None.	Meaning: System error. XCF processing failed. Action: Retry the request one or more times. If the problem persists, record the return code, and supply it to the appropriate IBM® support personnel.