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.

*Buffer

Supplied parameter

Type: character string
Length: up to 4096 bytes

*Buffer specifies the address of the storage where the ENF68 event data is to be returned. This data is mapped by the HWIENF68 structure in the HWICIC header file.

BufferSize

Supplied parameter

Type: integer
Length: 4 bytes

BufferSize specifies the size of the *Buffer storage area.

Constant HWIUSS_MAX_GETBUFFER_SIZE can be used to allocate a buffer large enough to hold the maximum size of ENF68 data returned.

Timeout

Supplied parameter

Type: integer
Length: 4 bytes

Timeout specifies the amount of time, in seconds, for which the service should wait for an event to occur.

Constant in Hexadecimal Equate Symbol	Description
0 HWIUSS_TIMEOUT_NOWAIT	Do not wait for an event to occur if one is not ready for delivery.
FFFFFFFF HWIUSS_TIMEOUT_INFINITE	Do not return until an event has occurred.
Any other non-negative number	Wait for the specified number of seconds.

Note: If the Hwi_Event_BCPIIStatus event is not registered by the application and the BCPii address space goes down, this service will not be completed if HWIUSS_TIMEOUT_INFINITE was specified. If a numeric value was specified, the service will wake up but neither event data nor indicator that BCPii is not available will be returned. IBM recommends that an application specifies the Hwi_Event_BCPIIStatus event on the HwiManageEvents service call if the HwiGetEvent service is used. When the HwiGetEvent service returns control to the application, an inspection of which event was received will allow the application to react appropriately when BCPii stops.

*BytesNeeded

Returned parameter

Type: integer
Length: 4 bytes

*BytesNeeded specifies the variable to contain the number of bytes used in the output buffer to contain the returned event data. If the buffer is not large enough to contain all the event data, this variable contains the amount of storage required to receive all the event data.