Return and Reason Codes

When the HZSPWRIT 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 HZSPWRIT Macro
Return Code	Reason Code	Equate Symbol Meaning and Action
0	—	Equate Symbol: HzspwritRc_OK Meaning: The request was successfully processed. Action: None required
8	—	Equate Symbol: HzspwritRc_InvParm Meaning: HZSPWRIT request specified incorrect parameters. Action: Refer to action under the individual reason code.
8	xxxx0801	Equate Symbol: HzspwritRsn_NotAuthorized Meaning: Caller is not authorized to write persistent data for this check Action: Avoid calling HZSPWRIT to write data when not authorized.
8	xxxx0808	Equate Symbol: HzspwritRsn_BadENV Meaning: HZSPWRIT is supported only when called within the HZS address space. Action: Invoke HZSPWRIT only within the HZS address space.
8	xxxx0818	Equate Symbol: HzspwritRsn_BadParmlist Meaning: Error accessing parameter list. Action: Make sure that the provided parameter list is valid.
8	xxxx0843	Equate Symbol: HzspwritRsn_SrbMode Meaning: SRB mode. Action: Avoid issuing HZSPWRIT in SRB mode.
8	xxxx0844	Equate Symbol: HzspwritRsn_NotEnabled Meaning: Not Enabled. Action: Avoid using HZSPWRIT when not enabled.
8	xxxx0845	Equate Symbol: HzspwritRsn_Locked Meaning: Locked Action: Avoid using HZSPWRIT when a lock is held.
8	xxxx0846	Equate Symbol: HzspwritRsn_FRR Meaning: The caller had an EUT FRR established. Action: Avoid using HZSPWRIT when an EUT FRR is established.
8	xxxx0847	Equate Symbol: HzspwritRsn_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: HzspwritRsn_BadBufferALET Meaning: Bad buffer ALET. Action: Make sure that the ALET associated with the buffer is valid. The access register might not have been set up correctly.
8	xxxx0849	Equate Symbol: HzspwritRsn_BadBuffer Meaning: Error accessing buffer Action: Make sure that the provided buffer is valid.
8	xxxx0858	Equate Symbol: HzspwritRsn_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.
8	xxxx085A	Equate Symbol: HzspwritRsn_WrongRemoteFunction Meaning: The check routine is not currently processing either the INITRUN or the RUN remote function. Action: Avoid invoking HZSPWRIT for a remote check when not within the INITRUN or RUN function.
8	xxxx085B	Equate Symbol: HzspwritRsn_BadRemoteEnvironment Meaning: HZSPWRIT was invoked from a task other than the one that issued HZSCHECK REQUEST=OPSTART. Action: Avoid invoking HZSPWRIT from an incorrect task.
8	xxxx0861	Equate Symbol: HzspwritRsn_WrongFunction Meaning: The check routine is not currently processing either the INIT, CHECK, or CLEANUP function. Action: Avoid invoking HZSPWRIT for a local check when not within the INIT or CHECK function.
0C	—	Equate Symbol: HzspwritRc_EnvError Meaning: Environmental Error Action: Refer to action under the individual reason code.
0C	xxxx0C15	Equate Symbol: HzspwritRsn_DataCorrupted Meaning: The persistent data being managed by the system for this check has been overlaid. It will not be written to the HZSPDATA data set. Action: Report the problem to the system programmer
10	—	Equate Symbol: HzspwritRc_CompError Meaning: Component Error Action: Refer to action under the individual reason code.
10	xxxx1001	Equate Symbol: HzspwritRsn_IntError Meaning: Unexpected internal error Action: Report the problem to the system programmer