Parameters

The parameters are explained as follows:

*DiagArea

Returned parameter

Type: character string
Length: 32 bytes

*DiagArea contains diagnostic data to help determine the cause of a failure from the service. For many return codes, the *DiagArea can contain further information to help determine the cause of the failure. See the descriptions of different return codes for a partial list of data returned in this area.

Note: For all environmental errors (with return code X'F00' and higher), the *DiagArea might not be filled in, and the data returned in the area should be ignored.

Field Name	Field Type	Description
Diag_Index	32-bit integer	The array index to the parameter field that causes the error.
Diag_Key	32-bit integer	The constant value represents the field that causes the error.
Diag_Actual	32-bit integer	The incorrect actual value specified.
Diag_Expected	32-bit integer	The expected value to be used.
Diag_CommErr	32-bit integer	The returned code from the failing operation.
Diag_Text	Character (12)	Additional diagnostic information in text format.

See BCPii communication error reason codes for a partial list of the descriptive communication transport error return codes and suggested actions.

*DeliveryToken

Supplied parameter

Type: character string
Length: 8 bytes

*DeliveryToken specifies the event notification connection, as returned by a previous HWIBeginEventDelivery call.

ConnectToken

Supplied parameter

Type: character string
Length: 16 bytes

ConnectToken specifies a logical connection between the application and a CPC or an image. The ConnectToken is an output parameter on the HWICONN service call.

The ConnectToken specified must have originated from a HWICONN service call that was issued from the same address space as this service call.

EventAction

Supplied parameter

Type: integer
Length: 4 bytes

EventAction specifies the type of action for the service. See the EventAction parameter of HWIEVENT — Register or unregister for BCPii events for the exact syntax.

EventIDs

Supplied parameter

Type: integer
Length: 128 bit (16 bytes)

EventIDs specifies the events to be added or deleted. See the EventIDs parameter of HWIEVENT — Register or unregister for BCPii events for the exact syntax.

IBM recommends that an application should at least add the Hwi_Event_BCPIIStatus event if other events are going to be added by the application. The only way to listen for BCPii events in the z/OS UNIX System Services environment is to issue a blocking call to the HwiGetEvent service. If BCPii stops and the Hwi_Event_BCPIIStatus has not been added, the application has no way of knowing of this termination and may hang indefinitely. By at least listening to this event, an application can be aware of BCPii terminations and take the appropriate action.