Edit

GetEventBuffer function

  • Article

The GetEventBuffer WMI method retrieves the next events in the HBA's event queue.

Syntax

void GetEventBuffer(
   [out, HBA_STATUS_QUALIFIERS] HBA_STATUS         HBAStatus,
   [out] uint32                                    EventCount,
   [out, WmiSizeIs("EventCount")] MSFC_EventBuffer Events[]
);

Parameters

HBAStatus
On return, contains a WMI qualifier value that indicates the status of the operation. For a list of allowed values and their descriptions, see HBA_STATUS. The miniport driver returns this information in the HBAStatus member of a GetEventBuffer_OUT structure.

EventCount
On return, indicates the number of events whose information was retrieved. The miniport driver returns this information in the EventCount member of a GetEventBuffer_OUT structure.

Events[]
An array of structures of type MSFC_EventBuffer that contain information about the next events in the HBA event queue. The miniport driver returns this information in the Events member of a GetEventBuffer_OUT structure.

Return value

Not applicable to WMI methods.

Remarks

The GetEventBuffer method removes events from the queue after retrieving their information.

This WMI method belongs to the MSFC_HBAAdapterMethods WMI Class.

Requirements

Target platform

 Desktop

Header

 Hbapiwmi.h (include Hbapiwmi.h, Hbaapi.h, or Hbaapi.h)

Library

 Hbaapi.lib

See also

GetEventBuffer_OUT

MSFC_EventBuffer