Return codes

When the service returns control to the caller, GPR 15 and ReturnCode contain a hexadecimal return code.

Return Code in Hexadecimal Equate Symbol	Return Code in Decimal Equate Symbol	Meaning and Action
0 HWI_OK	0 HWI_OK	Meaning: Successful completion. Action: None.
100 HWI_CONNECT_TOKEN_INV	256 HWI_CONNECT_TOKEN_INV	Meaning: Program error. The specified connect token is not valid. This return code indicates that one of the following conditions has occurred: The connect token does not exist. A previous HWICONN service call has never returned the value specified on OutConnectToken. The connect token does not represent an active connection. The connection specified might have already been disconnected by the HWIDISC service call. The connect token is not associated with the address space of the caller. The ConnectToken specified is associated with a different address space than the caller of this service call. Action: Check for probable coding error.
101 HWI_COMMUNICATION_ERROR	257 HWI_COMMUNICATION_ERROR	Meaning: A communication error is detected. The hardware management console application API (HWMCA) or the BCPii transport layer has returned with a failing return code. Action: See the DiagArea for further diagnostic information. The Diag_CommErr indicates the return code that is returned from HWMCA APIs or the BCPii transport layer. BCPiis CTRACE might provide further diagnostic information if the problem can not easily be resolved. See z/OS MVS System Commands for further information about starting and stopping CTRACE. HWMCA API and BCPii transport return codes are provided in BCPii communication error reason codes.
102 HWI_DIAGAREA_INV	258 HWI_DIAGAREA_INV	Meaning: Program error. The DiagArea is not accessible. Action: Check for probable coding error. Verify that the specified DiagArea is defined as a 32-byte character field.
103 HWI_CONNECT_TOKEN_INACTIVE	259 HWI_CONNECT_TOKEN_INACTIVE	Meaning: The specified connect token is no longer valid. The connection has been disconnected, or it is in the progress of being disconnected. Action: Check for probable coding error. Verify that the specified connect token is still active. If connectivity to the targeted CPC connection no longer exists, all connections associated with that CPC will no longer have a connect token that can be used.
104 HWI_TARGET_CPC_CHANGED	260 HWI_TARGET_CPC_CHANGED	Meaning: The CPC name represented by the specified token is valid but does not represent the same physical machine that was targeted by the initial HWICONN call. All connections that were established prior to the name change can no longer be used. Action: The application should cease using this connect token. If the application intends to target the CPC using the name represented by the specified connect token, it must first reconnect to the CPC before issuing any BCPii service call.
701 HWI_EVENT_EXITMODE_INV	1793 HWI_EVENT_EXITMODE_INV	Meaning: Program error. The requested EventExitMode on the call is not valid. The system rejects the service call. Action: Check for probable coding error.
702 HWI_EVENT_EXITADDR_INV	1794 HWI_EVENT_EXITADDR_INV	Meaning: Program error. The requested EventExitAddr on the call is not valid. The system rejects the service call. Action: Check for probable coding error.
703 HWI_EVENT_ACTION_INV	1795 HWI_EVENT_ACTION_INV	Meaning: Program error. The requested EventAction on the call is not valid. The system rejects the service call. Action: Check for probable coding error.
704 HWI_EVENT_IDS_INV	1796 HWI_EVENT_IDS_INV	Meaning: Program error. The requested EventIDs on the call is not valid. The system rejects the service call. This return code indicates one of the following conditions has occurred: The first 12 bytes of the EventIDs parameter is not equal to the expected Eyecatcher of HWIEVENTBLCK (non-REXX only). The reserved area of the EventIDs parameter contains a non-zero value. The EventIDs specified applies only to a CPC connection, but the ConnectToken specified represents an image or capacity record connection. The EventIDs specified applies only to image connections, but the ConnectToken specified represents a CPC or capacity record connection. A request which specified an EventAction of HWI_EVENT_DELETE also specified EventIDs of one or more events that were not registered on a previous HWIEVENT EventAction = HWI_EVENT_ADD request for the connection. Action: Check for probable coding error.
F00 HWI_NOT_AVAILABLE	3840 HWI_NOT_AVAILABLE	Meaning: BCPii is not available, and the system rejects the service request. Action: Notify the system programmer to start the BCPii address space and try the request again. See Restarting the HWIBCPii address space about how to start the BCPii address space. Programs can also listen to ENF68 to determine when BCPii services are available. See z/OS MVS Programming: Authorized Assembler Services Reference EDT-IXG for how to listen for BCPii activation messages.
F01 HWI_AUTH_FAILURE	3841 HWI_AUTH_FAILURE	Meaning: The caller is PKM8-15 problem state and the program does not reside in an APF-authorized library. Action: Check the calling program for a probable coding error.
F02 HWI_NO_SAF_AUTH	3842 HWI_NO_SAF_AUTH	Meaning: The user does not have correct SAF authorization for the request. Action: Check for probable error. Consider one or more of the following possible actions: Define read access authorization to the FACILITY class resource profile HWI.APPLNAME.HWISERV. Define read access authorization to the FACILITY class resource profile HWI.TARGET.netid.nau for CPC connection. Define read access authorization to the FACILITY class resource profile HWI.TARGET.netid.nau.imagename for an image connection. Ensure that the referenced FACILITY class profiles are RACLIST-specified.
F03 HWI_INTERRUPT_STATUS_INV	3843 HWI_INTERRUPT_STATUS_INV	Meaning: The calling program is disabled. The system rejects this service request. Action: Check the calling program for a probable coding error.
F04 HWI_MODE_INV	3844 HWI_MODE_INV	Meaning: The calling program is not in task mode. The system rejects this service request. Action: Check the calling program for a probable error.
F05 HWI_LOCKS_HELD	3845 HWI_LOCKS_HELD	Meaning: The calling program is holding one or more locks. The system rejects this service request. Action: Check the calling program for a probable coding error.
F06 HWI_UNSUPPORTED_RELEASE	3846 HWI_UNSUPPORTED_RELEASE	Meaning: The system level does not support this service. The system rejects this service request. Action: Remove the calling program from the system, and install it on a system that supports BCPii services. Then run the calling program again.
F07 HWI_UNSUPPORTED_ENVIRONMENT	3847 HWI_UNSUPPORTED_ENVIRONMENT	Meaning: The system does not support execution of the service from the current environment (for example, calling a BCPii service from within a BCPii ENF exit routine). Action: Issue the BCPii service from a different execution environment.
FFF HWI_UNEXPECTED_ERROR	4095 HWI_UNEXPECTED_ERROR	Meaning: System error. The service that was called encountered an unexpected error. The system rejects the service call. Action: Search problem reporting data bases for a fix for the problem. If no fix exists, contact the IBM Support Center.