HBA_GetEventBuffer routine

The HBA_GetEventBuffer routine retrieves the indicated number of events, if available, from the HBA's event queue.

Syntax

HBA_STATUS HBA_API HBA_GetEventBuffer(
  _In_    HBA_HANDLE     handle,
  _Out_   PHBA_EVENTINFO EventBuffer,
  _Inout_ HBA_UINT32     *EventCount
);

Parameters

  • handle [in]
    Contains a value returned by the routine HBA_OpenAdapter that identifies the HBA on which the port is located.

  • EventBuffer [out]
    Pointer to a buffer that on return holds a structure of type HBA_EventInfo that contains information about an event.

  • EventCount [in, out]
    Indicates, on input, the number of event records that fit in the buffer pointed to by EventBuffer. If the full number of events requested cannot be retrieved, on return, this member contains the number of event records actually retrieved.

Return value

The HBA_GetEventBuffer routine returns a value of type HBA_STATUS that indicates the status of the HBA. In particular, HBA_GetEventBuffer returns one of the following qualifiers.

Return code Description
HBA_STATUS_OK

Returned if the operation was successful and EventCount indicates the number of event records returned.

HBA_STATUS_ERROR

Returned if an unspecified error occurred that prevented the retrieval of the event records.

 

Requirements

Target platform

Desktop

Header

Hbaapi.h (include Hbaapi.h)

Library

Hbaapi.lib

DLL

Hbaapi.dll

See also

HBA_OpenAdapter

HBA_EventInfo

HBA_STATUS

 

 

Send comments about this topic to Microsoft