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: 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.
301 HWI_LISTTYPE_INV	Meaning: Program error. The requested LISTTYPE specified in the call is not valid. The system rejects the service call. This return code indicates one of the following conditions has occurred: The ListType specified is not in the acceptable value range of possible list types. The ListType specified is incompatible with the InConnectToken specified. For example: The ListType specified applies only to CPC connections, but the ConnectToken specified represents an image connection. The ListType specified applies only to image connections, but the ConnectToken specified represents a CPC connection. For ListType HWI_LIST_EVENTS, the ConnectToken must not represent a capacity record because capacity record events do not have events directly associated with capacity records connections. Capacity-related events are associated with a CPC connection. Action: Check for probable coding error. Validate that the ListType specified is in the valid range of possible values, and that the ListType specified is permitted for the specified connection type.
302 HWI_DATA_EXCEEDED	Meaning: Program error. The amount of returned data exceeded the size of the answer area. No data or only partial data is returned. Action: Check for probable coding error. See the DiagArea for further diagnostic information. The Diag_Actual indicates the application-specified length. The Diag_Expected indicates the size required for the AnswerArea.
303 HWI_ANSWERAREA_INACCESSIBLE	Meaning: Program error. The answer area data area is either partially or completely inaccessible by the application and the Base Control Program internal interface (BCPii) address space. Action: Check for probable coding error. Verify that the AnswerArea_Ptr points to a data area where the answer area is and make sure the data area is accessible.
304 HWI_LIST_NODATA_RETURNED	Meaning: There is no data to be returned or the caller does not have enough access to display the listed values. Action: Check for probable coding error. Verify that proper access is granted for the request.
305 HWI_LISTTYPE_NOT_SUPPORTED	Meaning: The targeted hardware of the HWILIST request does not support the request attempted by the program. Action: Verify that the targeted hardware supports the type of request being made.
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.APPLNAME.HWISERV. Define read access authorization to the FACILITY class resource profile HWI.TARGET.netid.nau.imagename for HWI_LIST_IMAGES ListType. Define read access authorization to the FACILITY class resource profile HWI.CAPREC.netid.nau.caprec for HWI_LIST_CAPRECS ListType. For a ListType of HWI_LIST_EVENTS, define read access authorization to the FACILITY class resource profile HWI.TARGET.netid.nau for a CPC connection, and HWI.TARGET.netid.nau.imagename for an image connection. For a ListType of HWI_LIST_LOCALCPC, define read access authorization to the FACILITY class resource profile HWI.TARGET.netid.nau where netid.nau represents the local CPC network address. For a ListType of HWI_LIST_LOCALIMAGE, define read access authorization to the FACILITY class resource profile HWI.TARGET.netid.nau.imagename where netid.nau represents the local CPC network address and imagename represents the local image (LPAR) name. For the ListType of HWI_LIST_RESET_ACTPROF, HWI_LIST_IMAGE_ACTPROF, HWI_LIST_LOAD_ACTPROF, or HWI_LIST_IMAGEGROUPS, define read access authorization to the FACILITY class resource profile HWI.TARGET.netid.nau for the CPC where the activation profiles or image groups to be listed are defined. Ensure that the referenced facility class profiles are 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.