Return and Reason Codes
- GPR 15 (and retcode, when you code RETCODE) contains a return code.
- When the value in GPR 15 is not zero, GPR 0 (and rsncode, when you code RSNCODE) contains a reason code.
Macro HZSZCONS provides equate symbols for the return and reason codes.
The following table identifies the hexadecimal return and reason codes and the equate symbol associated with each reason code. IBM® support personnel may request the entire reason code, including the xxxx value.
| Return Code | Reason Code | Equate Symbol Meaning and Action |
|---|---|---|
| 0 | — | Equate Symbol: HzsqueryRc_OK Meaning: Requested information returned Action: None required |
| 4 | — | Equate Symbol: HzsqueryRc_Warn Meaning: Warning Action: Refer to action under the individual reason code. |
| 4 | xxxx0401 | Equate Symbol: HzsqueryRsn_NotAllDataReturned Meaning: Not all data was returned because the answer area is not big enough. Answer area field HZSQUAAHTLEN /HZSQUAAH64TLEN indicates how much space is currently required. Action: Allocate a larger area and request the function again. |
| 8 | — | Equate Symbol: HzsqueryRc_InvParm Meaning: HZSQUERY request specifies incorrect parameters. Action: Refer to action under the individual reason code. |
| 8 | xxxx0801 | Equate Symbol: HzsqueryRsn_NotAuthorized Meaning: Caller is not authorized. For INSTANCE=LOGSTREAM, the first eight bytes of the DIAG area in the header (HZSQUAAHDIAG or HZSQUAAH64DIAG) contain the four-byte return code and four-byte reason code from the IXGCONN service. Action: Avoid calling HZSQUERY when not authorized |
| 8 | xxxx0818 | Equate Symbol: HzsqueryRsn_BadParmlist Meaning: Error accessing parameter list. Action: Make sure that the provided parameter list is valid. |
| 8 | xxxx0838 | Equate Symbol: HzsqueryRsn_BadParmListVersion Meaning: The specified version of the macro is not compatible with the current version of IBM Health Checker for z/OS®. Action: Avoid requesting parameters that are not supported by this version of IBM Health Checker for z/OS. |
| 8 | xxxx0843 | Equate Symbol: HzsqueryRsn_SrbMode Meaning: SRB mode. Action: Avoid issuing HZSQUERY in SRB mode. |
| 8 | xxxx0844 | Equate Symbol: HzsqueryRsn_NotEnabled Meaning: Not Enabled. Action: Avoid using HZSQUERY when not enabled. |
| 8 | xxxx0845 | Equate Symbol: HzsqueryRsn_Locked Meaning: Locked Action: Avoid using HZSQUERY when a lock is held. |
| 8 | xxxx0846 | Equate Symbol: HzsqueryRsn_FRR Meaning: The caller had an EUT FRR established. Action: Avoid using HZSQUERY when an EUT FRR is established. |
| 8 | xxxx0847 | Equate Symbol: HzsqueryRsn_BadParmlistALET Meaning: Bad parameter list ALET. Action: Make sure that the ALET associated with the parameter list is valid. The access register might not have been set up correctly. |
| 8 | xxxx0848 | Equate Symbol: HzsqueryRsn_BadAnsAreaALET Meaning: Bad answer area ALET. Action: Make sure that the ALET associated with the answer area is valid. The access register might not have been set up correctly. |
| 8 | xxxx0849 | Equate Symbol: HzsqueryRsn_BadAnsArea Meaning: Error accessing answer area. Action: Make sure that the provided answer area is valid. |
| 8 | xxxx084A | Equate Symbol: HzsqueryRsn_BadAnsLen Meaning: AnsLen is less than size of the header area. Action: Provide a larger answer area (as indicated by the ANSLEN keyword). |
| 8 | xxxx084B | Equate Symbol: HzsqueryRsn_BadParmlistValue Meaning: A parameter list field contains an unsupported value. Action: Check for possible storage overlay |
| 8 | xxxx084C | Equate Symbol: HzsqueryRsn_BadCategoryALET Meaning: Bad category ALET. Action: Make sure that the ALET associated with the category area is valid. The access register might not have been set up correctly. |
| 8 | xxxx084D | Equate Symbol: HzsqueryRsn_BadCategory Meaning: Error accessing category area. Action: Make sure that the provided category area is valid. |
| 8 | xxxx084E | Equate Symbol: HzsqueryRsn_MsgTokenNotValid Meaning: MSGTOKEN is not valid. Action: Make sure that the MSGTOKEN specifies a value returned by HZSQUERY. As that might represent a check that no longer exists, it might be necessary to re-issue HZSQUERY to get a new MSGTOKEN. |
| 8 | xxxx085C | Equate Symbol: HzsqueryRsn_XM Meaning: For INSTANCE=LOGSTREAM, a cross-memory environment exists. Action: Avoid using HZSQUERY INSTANCE=LOGSTREAM when the primary address space does not match the home address space. |
| 8 | xxxx085D | Equate Symbol: HzsqueryRsn_BadQUAAC1HDRALET Meaning: Bad QUAAC1HDR ALET. Action: Make sure that the ALET associated with the QUAAC1HDR area is valid. The access register might not have been set up correctly. |
| 8 | xxxx085E | Equate Symbol: HzsqueryRsn_BadQUAAC1HDR Meaning: Error accessing QUAAC1HDR area. Action: Make sure that the provided QUAAC1HDR area is valid. |
| 0C | — | Equate Symbol: HzsqueryRc_EnvError Meaning: Environmental Error Action: Refer to action under the individual reason code. |
| 0C | xxxx0C01 | Equate Symbol: HzsqueryRsn_IBMHCNotActive Meaning: IBM Health Checker for z/OS is not active Action: Re-issue the request when the service is available |
| 0C | xxxx0C21 | Equate Symbol: HzsqueryRsn_LogstreamRecordNotFound Meaning: The requested record within the logstream specified within the QUAAC1HDR area could not be found. The requested data could not be retrieved. The first eight bytes of the DIAG area in the header (HZSQUAAHDIAG or HZSQUAAH64DIAG) contain the four-byte return code and four-byte reason code from the IXGBRWSE service.
Action: Avoid calling HZSQUERY when the BlockID returned within the QUAAC1HDR area is 0. If the BlockID was not 0, notify the system programmer. |
| 0C | xxxx0C22 | Equate Symbol: HzsqueryRsn_LogstreamGap Meaning: A gap was detected in the logstream specified within the QUAAC1HDR area. The requested data could not be retrieved. The first eight bytes of the DIAG area in the header (HZSQUAAHDIAG or HZSQUAAH64DIAG) contain the four-byte return code and four-byte reason code from the IXGBRWSE service. Action: Notify the system programmer. |
| 0C | xxxx0C23 | Equate Symbol: HzsqueryRsn_LogstreamLossOfData Meaning: A loss of data was detected in the logstream specified within the QUAAC1HDR area. The system received reason code IxgRsnCodeWarningLossOfData when attempting to browse the logstream. The requested data could not be retrieved. The first eight bytes of the DIAG area in the header (HZSQUAAHDIAG or HZSQUAAH64DIAG) contain the four-byte return code and four-byte reason code from the IXGBRWSE service. Action: Notify the system programmer. |
| 0C | xxxx0C24 | Equate Symbol: HzsqueryRsn_LogstreamError Meaning: The system received an unexpected return / reason code from a system logger function. The requested data could not be retrieved. The first eight bytes of the DIAG area in the header (HZSQUAAHDIAG or HZSQUAAH64DIAG) contain the four-byte return code and four-byte reason code from the IXGBRWSE service. Action: Notify the system programmer. |
| 0C | xxxx0C25 | Equate Symbol: HzsqueryRsn_LogstreamBadData Meaning: The data retrieved from the logstream specified within the QUAAC1HDR area was not valid. Action: Notify the system programmer. |
| 0C | xxxx0C26 | Equate Symbol: HzsqueryRsn_StorageNotAvailable Meaning: The system could not obtain working storage needed to process the request. Action: Try re-running the job with a larger region size. |
| 0C | xxxx0C27 | Equate Symbol: HzsqueryRsn_BadLogstream Meaning: The system could not connect to the logstream specified within the QUAAC1HDR area. The first eight bytes of the DIAG area in the header (HZSQUAAHDIAG or HZSQUAAH64DIAG) contain the four-byte return code and four-byte reason code from the IXGCONN service. Action: Make sure that the area has been properly initialized and that the logstream data set is accessible. Make sure that the system logger is active. |
| 10 | — | Equate Symbol: HzsqueryRc_CompError Meaning: Component Error Action: Refer to action under the individual reason code. |
| 10 | xxxx1001 | Equate Symbol: HzsqueryRsn_IntError Meaning: Unexpected internal error Action: Report the problem to the system programmer |
One of the reasons
that this might occur is an expired logstream retention period and
therefore some check history entries have been deleted by the system.