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 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 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: 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. In some cases, the Diag_Index and Diag_Key may contain additional details. 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 that 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.
401 HWI_QUERYPARM_ATTRIB_INV	Meaning: Program error. One of the requested attribute identifiers in the QueryParm is not valid. The system rejects the service call. This return code indicates that one of the following conditions has occurred: The Query attribute identifier specified is not in the acceptable value range of possible attributes. The specified Query attribute identifier 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, a capacity record connection, or any of the activation profile connections. Action: Check for probable coding error. Validate that the Query attribute specified is in the valid range of possible values. Validate that the Query attribute specified is permitted for the specified connection type. See the DiagArea for further diagnostic information: The Diag_Index field specifies the index of the element in the attribute array that is in error. The Diag_Key contains the attribute identifier specified. The Diag_Text contains “Invalid Attr” if the attribute is one whose value cannot be queried. If the attribute cannot be queried for the specified connection type, the Diag_Text contains “Mismatch.”
402 HWI_QUERYPARM_INACCESSIBLE	Meaning: Program error. The QueryParm data area is either partially or completely inaccessible by the application, the Base Control Program internal interface (BCPii) address space, or both. Action: Check for probable coding error. Consider the following possibilities: The QueryParm length could be too small. The size of QueryParm must be at least the product of the NumofAttributes parameter and the length of the data area mapping for each attribute (16 bytes). The NumofAttributes value can be larger than the number of parameters actually passed.
403 HWI_QUERYPARM_ATTRIBRETADDR _INACCESSIBLE	Meaning: Program error. Storage that is pointed to by one or more of the attribute value pointers in the QueryParm is not accessible by the application. The system is not able to return data for this attribute identifier. Partial data might have already been returned. Action: Check for probable coding error. See the DiagArea for further diagnostic information. The Diag_Index field specifies the array index that contained the inaccessible AttributeValuePtr. The Diag_Key contains the erroneous attribute identifier.
404 HWI_QUERYPARM_ATTRIB_LENGTH_ INV	Meaning: Program error. One of the attribute lengths specified is too small. There is not enough space to contain all of the returned data for this particular attribute. The system returns partial data, filling in the attribute data area for the length specified. Action: Check for probable coding error. See the DiagArea for further diagnostic information. The Diag_Index field specifies the array index which contained the partially filled-in value. The Diag_Key is the attribute identifier constant that causes the error. The Diag_Actual indicates the application-specified length. The Diag_Expected indicates the size required for the returned data.
405 HWI_QUERY_NUMOFATTRIB_INV	Meaning: Program error. The NumOfAttributes specified on the call is not valid. The NumOfAttributes value must be in the range of 1 to 64. Action: Check for probable error. Verify that the NumOfAttributes specified is greater than zero and less than or equal to 64.
406 HWI_QUERY_ATTRIBUTE_NOT SUPPORTED	Meaning: The targeted hardware of the HWIQUERY request does not recognize the attribute attempted to be retrieved. Action: Verify that the targeted hardware is at a level that supports the type of attribute being queried.
407 HWI_QUERY_TARGET_DEACTIVATED	Meaning: A query attribute could not be retrieved because the targeted object is deactivated. Action: Verify that the targeted object is activated. Activate the object before attempting to retrieve this same attribute again.
408 HWI_QUERY_ATTRIB_TEMP_NOT_AVAILABLE	Meaning: One or more query attributes could not be retrieved because the support element (SE) is temporarily unavailable. Action: Try this request again at a later time. If the problem persists, contact the IBM Support Center.
F00 HWI_NOT_AVAILABLE	Meaning: BCPii services are 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	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	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.TARGET.netid.nau for CPC, activation profile, or user-defined image group connections. Define read access authorization to the FACILITY class resource profile HWI.TARGET.netid.nau.imagename for an image connections. Define read access authorization to the FACILITY class resource profile HWI.CAPREC.netid.nau.caprecid for a capacity record 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. 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 BCPii services. Then run the calling program again.
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 data bases for a fix for the problem. If no fix exists, contact the IBM Support Center.