Return and Reason Codes

When the HZSCHECK macro returns control to your program:

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.

Table 1. Return and Reason Codes for the HZSCHECK Macro
Return Code	Reason Code	Equate Symbol Meaning and Action
0	—	Equate Symbol: HzscheckRc_OK Meaning: SECCHECKONLY=YES was requested and the request passed the security check. Action: None required.
4	—	Equate Symbol: HzscheckRc_Warn Meaning: Warning Action: Refer to action under the individual reason code.
4	xxxx0400	Equate Symbol: HzscheckRsn_CommandQueued Meaning: The specified HZSCHECK will be completed asynchronously Action: None needed
8	—	Equate Symbol: HzscheckRc_InvParm Meaning: HZSCHECK request specifies incorrect parameters. Action: Refer to action under the individual reason code.
8	xxxx0801	Equate Symbol: HzscheckRsn_NotAuthorized Meaning: Caller is not authorized Action: Avoid calling HZSCHECK when not authorized.
8	xxxx0818	Equate Symbol: HzscheckRsn_BadParmlist Meaning: Error accessing the parameter list Action: Make sure that the provided parameter list is valid.
8	xxxx0829	Equate Symbol: HzscheckRsn_BadAddRepcatArea Meaning: Error while reading the AddCat or RepCat array Action: Make sure that the provided area is valid.
8	xxxx082A	Equate Symbol: HzscheckRsn_BadRemcatArea Meaning: Error while reading the RemCat array Action: Make sure that the provided area is valid.
8	xxxx0838	Equate Symbol: HzscheckRsn_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	xxxx0847	Equate Symbol: HzscheckRsn_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	xxxx084B	Equate Symbol: HzscheckRsn_BadParmlistValue Meaning: A parameter list field contains an unsupported value. Action: Check for possible storage overlay
8	xxxx084C	Equate Symbol: HzscheckRsn_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: HzscheckRsn_BadCategoryArea Meaning: Error accessing category area. Action: Make sure that the provided category area is valid.
8	xxxx0853	Equate Symbol: HzscheckRsn_BadAddRepcatALET Meaning: Bad ALET for AddCat or RepCat array. Action: Make sure that the ALET associated with the AddCat or RepCat array is valid. The access register might not have been set up correctly.
8	xxxx0854	Equate Symbol: HzscheckRsn_BadRemcatALET Meaning: Bad ALET for RemCat array. Action: Make sure that the ALET associated with the RemCat array is valid. The access register might not have been set up correctly.
8	xxxx0855	Equate Symbol: HzscheckRsn_BadNumCat Meaning: Value provided by NUMCAT exceeds the limit of 16. Action: Avoid specifying more than the allowable number of categories.
8	xxxx0856	Equate Symbol: HzscheckRsn_BadNumAddRepRemCat Meaning: The total value provided by NUMADDCAT, NUMREPCAT, and NUMREMCAT exceeds the limit of 16. Action: Avoid specifying more than the allowable number of categories.
8	xxxx0858	Equate Symbol: HzscheckRsn_BadHandle Meaning: The handle provided with the HANDLE parameter is not valid. Action: Specify the handle that was returned by the HZSADDCK macro if this is a REMOTE=YES REXX=NO check, or the handle in REXX variable hzs_handle if this is a REMOTE=YES REXX=YES check.
8	xxxx0863	Equate Symbol: HzscheckRsn_BadPEToken Meaning: The PEToken is not one obtained using authlvl of IEA_UNAUTHORIZED. Action: Specify a valid PEToken.
8	xxxx0864	Equate Symbol: HzscheckRsn_BadPqeArea Meaning: Error while writing to the PQE area Action: Make sure that the provided area is valid.
8	xxxx0865	Equate Symbol: HzscheckRsn_BadPqeALET Meaning: Bad ALET for the PQE area. Action: Make sure that the ALET associated with the PQE area is valid. The access register might not have been set up correctly.
8	xxxx0866	Equate Symbol: HzscheckRsn_BadPqeChkWorkArea Meaning: Error while reading from the PqeChkWork area Action: Make sure that the provided area is valid.
8	xxxx0867	Equate Symbol: HzscheckRsn_BadPqeChkWorkALET Meaning: Bad ALET for the PqeChkWork area. Action: Make sure that the ALET associated with the PqeChkWork area is valid. The access register might not have been set up correctly.
8	xxxx086A	Equate Symbol: HzscheckRsn_BadPETokenHome Meaning: The PEToken is not one obtained in the HOME address space. Action: Specify a valid PEToken.
8	xxxx086B	Equate Symbol: HzscheckRsn_BadPETokenState Meaning: The PEToken is not in a state ready to be used for a PAUSE. Action: Specify a valid PEToken.
8	xxxx086C	Equate Symbol: HzscheckRsn_BadPETokenValue Meaning: The PEToken appears corrupted. Action: Specify a valid PEToken.
0C	—	Equate Symbol: HzscheckRc_EnvError Meaning: Environmental Error Action: Refer to action under the individual reason code.
0C	xxxx0C01	Equate Symbol: HzscheckRsn_IBMHCNotActive Meaning: IBM Health Checker for z/OS is not active Action: For REQUEST=ADDNEW, no action is needed. For any other REQUEST option, re-issue the request when the service is available
0C	xxxx0C02	Equate Symbol: HzscheckRsn_BadCommandEnv Meaning: The specified command cannot be specified from a HZSADDCHECK dynamic exit Action: Do Not issue a ADDNEW or REFRESH command from a HZSADDCHECK dynamic exit routine
0C	xxxx0C03	Equate Symbol: HzscheckRsn_BadRemoteEnv Meaning: For REQUEST=OPSTART or REQUEST=OPCOMPLETE, the call must be done only once after having been awakened to process a remote function. For that function, the call may be done only once. For REQUEST=OPSTART, the call must be done before the REQUEST=OPCOMPLETE call. Action: Avoid using REQUEST=OPSTART or REQUEST=OPCOMPLETE in an incorrect environment.
10	—	Equate Symbol: HzscheckRc_CompError Meaning: Component Error Action: Refer to action under the individual reason code.
10	xxxx1001	Equate Symbol: HzscheckRsn_IntError Meaning: Unexpected internal error Action: Report the problem to the system programmer
16	xxxx106D	Equate Symbol: HzscheckRsn_BadPETokenService Meaning: Unexpected error. Action: Ensure a valid PEToken has been specified. If this error repeats, contact IBM Support.