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	Meaning and Action
0 HWI_OK	Meaning: Successful completion. Action: None.
100 HWI_CONNECT_TOKEN_INV	Meaning: Program error. The specified connect token is not valid. This return code indicates 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 using 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	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: Check for probable coding error. 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. HWMCA API and BCPii transport return codes are provided in BCPii communication error reason codes.
102 HWI_DIAGAREA_INV	Meaning: Program error. The DiagArea is not accessible. Action: Check for probable coding error. Verify the specified DiagArea is defined as a 32-byte character field.
103 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.
501 HWI_SETTYPE_INV	Meaning: Program error. The requested SetType specified in the call is not valid for the ConnectToken specified. The system rejects the service call. This return code indicates one of the following conditions has occurred: The SetType specified is not in the acceptable value range of attributes that can be set. The specified SetType has been provided with an incompatible connection type. For example, the attribute identifier applies only to CPC connections, but the ConnectToken specified represents an image connection, or any of the activation profile connections. Action: Check for probable coding error. Validate that the SetType specified is in the valid range of possible values. Validate that the SetType specified is permitted for the specified connection type. See the DiagArea for further diagnostic information. The Diag_Key contains the value of the attribute in question. The Diag_Text contain “Bad Set Attr” if the value of the attribute cannot be set; the Diag_Text contains “Mismatch” if the attribute cannot be set for the specified connection type.
502 HWI_SETTYPE_VALUE_INV	Meaning: Program error. The requested SetTypeValue to be set or changed is not valid. The system rejects the service call. Action: Check for probable coding error. Validate that the value to which an attribute is being set is appropriate for that attribute.
503 HWI_SETTYPE_VALUE_LEN_INV	Meaning: Program error. The SetTypeValueLen specified is not valid. The SetTypeValueLen must be equal to or greater than the minimum required length for the set type value. Action: Check for probable coding error. Validate that the SetTypeValueLen specified is equal to or greater than the minimum required length for the set type value.
504 HWI_SETTYPE_VALUE _INACCESSIBLE	Meaning: Program error. The set type value data area is either partially or completely inaccessible by the application, or BCPii, or both. Action: Check for probable coding error. Verify the SetTypeValue_Ptr points to a data area where the set type value is, and make sure that the data area is accessible.
506 HWI_SET_ATTRIBUTE_NOT _SUPPORTED	Meaning: The targeted hardware of the HWISET request does not recognize the attribute that the user is attempting to set. Action: Verify that the targeted hardware is at a level that supports the type of attribute being set.
F00 HWI_NOT_AVAILABLE	Meaning: HWI is not available, and the system rejects the service request. Action: Start HWI and try the request again.
F01 HWI_AUTH_FAILURE	Meaning: The caller is PKM8-15 problem state. Action: Check the calling program for a probable coding error.
F02 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 update access authorization to the FACILITY class resource profile HWI.TARGET.netid.nau for a CPC connection. Define update access authorization to the FACILITY class resource profile HWI.TARGET.netid.nau.imagename for an image connection. Ensure that the referenced Facility Class Profile is RACLIST-specified.
F03 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	Meaning: The calling program is not in Task mode, which is the required mode. The system rejects this service request. Action: Check the calling program for a probable error.
F05 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	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 HWI. Then rerun the calling program.
F07 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	Meaning: System error. The service that was called encountered an unexpected error. The system rejects the service call. Action: Search problem reporting databases for a fix for the problem. If no fix exists, contact the IBM Support Center. In many cases, a dump has been taken by BCPii to attempt the collection of the necessary information to diagnose the error. If so, provide this dump to the IBM support team.