Return and Reason Codes

When the HZSADDCK 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 HZSADDCK Macro
Return Code	Reason Code	Equate Symbol Meaning and Action
0	—	Equate Symbol: HzsaddckRc_OK Meaning: The check was added to IBM Health Checker for z/OS®. Action: None required
4	—	Equate Symbol: HzsaddckRc_Warn Meaning: Warning Action: Refer to action under the individual reason code.
4	xxxx0401	Equate Symbol: HzsaddckRsn_CheckReplaced Meaning: The check replaced an active check that had an earlier date. Action: None required.
4	xxxx0402	Equate Symbol: HzsaddckRsn_CheckInactive Meaning: The check was added but will not run until its state is changed to active. Action: None required
4	xxxx0414	Equate Symbol: HzsaddckRsn_CheckIdentical Meaning: Check was not activated because a check with the specified name is already active. Action: None required
8	—	Equate Symbol: HzsaddckRc_InvParm Meaning: HZSADDCK request specifies incorrect parameters. Action: Refer to action under the individual reason code.
8	xxxx0801	Equate Symbol: HzsaddckRsn_CheckOld Meaning: The check was not added because a check with the same name is already being added. That other check has a more recent date than the date provided for this request. Action: Avoid adding the same check twice, or make sure that the single version of the check that you want to run has the most current date.
8	xxxx0804	Equate Symbol: HzsaddckRsn_BadCheckRoutine Meaning: This reason code is not part of the programming interface. Action: None.
8	xxxx0805	Equate Symbol: HzsaddckRsn_BadMessageTable Meaning: This reason code is not part of the programming interface. Action: None.
8	xxxx0808	Equate Symbol: HzsaddckRsn_BadENV Meaning: HZSADDCK for a REMOTE=NO, or a REXX=YES check must be called only from an exit routine associated with the HZSADDCHECK exit. Action: Issue HZSADDCK only from a supported environment.
8	xxxx0809	Equate Symbol: HzsaddckRsn_BadCheckName Meaning: The check name contained invalid characters. Action: Specify a valid check name.
8	xxxx080A	Equate Symbol: HzsaddckRsn_BadOwnerName Meaning: The check owner contained invalid characters. Action: Specify a valid check owner.
8	xxxx080B	Equate Symbol: HzsaddckRsn_BadDate Meaning: The date was not in the format YYYYMMDD or is after today's date. Action: Specify a valid date.
8	xxxx080C	Equate Symbol: HzsaddckRsn_BadReasonLen Meaning: The REASONLEN value is either 0 or exceeds the maximum of 256. Action: Specify a valid value for the REASONLEN parameter.
8	xxxx080D	Equate Symbol: HzsaddckRsn_BadExitRoutine Meaning: The exit routine name was all zeroes or all blanks. Action: Specify a valid exit routine.
8	xxxx080E	Equate Symbol: HzsaddckRsn_BadTime Meaning: The hours value exceeded 999 or the minutes value exceeded 60. Action: Specify valid hours and minutes values.
8	xxxx0818	Equate Symbol: HzsaddckRsn_BadParmlist Meaning: Error accessing parameter list. Action: Make sure that the provided parameter list is valid.
8	xxxx0838	Equate Symbol: HzsaddckRsn_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	xxxx0841	Equate Symbol: HzsaddckRsn_BadParmsArea Meaning: Error accessing the PARMS area. Action: Make sure that the provided PARMS area is valid.
8	xxxx0842	Equate Symbol: HzsaddckRsn_BadReasonArea Meaning: Error accessing the REASON area. Action: Make sure that the provided REASON area is valid.
8	xxxx084F	Equate Symbol: HzsaddckRsn_BadParmsLen Meaning: The PARMSLEN value is either 0 or exceeds the maximum of 256. Action: Specify a valid value for the PARMSLEN parameter.
8	xxxx0859	Equate Symbol: HzsaddckRsn_NotAuthorized Meaning: Caller is not authorized Action: Avoid calling HZSADDCK when not authorized.
8	xxxx0862	Equate Symbol: HzsaddckRsn_BadExceptionInterval Meaning: The EIHOURS value exceeded 999 or the EIMINUTES value exceeded 60. Action: Specify valid hours and minutes values.
8	xxxx0863	Equate Symbol: HzsaddckRsn_BadPEToken Meaning: The PEToken is not one obtained using authlvl of IEA_UNAUTHORIZED. Action: Specify a valid PEToken.
8	xxxx086A	Equate Symbol: HzsaddckRsn_BadPETokenHome Meaning: The PEToken is not one obtained in the HOME address space. Action: Action: Specify a valid PEToken.
8	xxxx086B	Equate Symbol: HzsaddckRsn_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: HzsaddckRsn_BadPETokenValue Meaning: The PEToken appears corrupted. Action: Specify a valid PEToken.
0C	—	Equate Symbol: HzsaddckRc_EnvError Meaning: Environmental Error Action: Refer to action under the individual reason code.
0C	xxxx0C01	Equate Symbol: HzsaddckRsn_IBMHCNotActive Meaning: IBM Health Checker for z/OS is not active Action: Re-issue the request when the service is available
10	—	Equate Symbol: HzsaddckRc_CompError Meaning: Component Error Action: Refer to action under the individual reason code.
10	xxxx1001	Equate Symbol: HzsaddckRsn_IntError Meaning: Unexpected internal error Action: Report the problem to the system programmer
16	xxxx106D	Equate Symbol: HzsaddckRsn_BadPETokenService Meaning: Unexpected error. Action: Ensure a valid PEToken has been specified. If this error repeats, contact IBM Support.