HBA_GetEventBuffer

- remove and return the next event from the HBA's event queue

Synopsis

cc [ flag… ] file… -lHBAAPI [ library… ]
#include <hbaapi.h>

HBA_STATUS HBA_GetEventBuffer(HBA_HANDLE handle,
     HBA_EVENTINFO *EventBuffer, HBA_UINT32 *EventBufferCount);

Parameters

handle

an open handle returned from HBA_OpenAdapter(3HBAAPI)

EventBuffer

a pointer to an HBA_EVENTINFO buffer

EventBufferCount

a pointer to the maximum number of events that can be stored in the HBA_EVENTINFO buffer. The value will be changed to the actual number of events placed in the buffer on completion.

Description

The HBA_GetEventBuffer() function retrieves events from the HBA's event queue. The number of events returned is the lesser of EventBufferCount and the number of events on the queue. The returned events are removed from the queue.

Return Values

Upon successful completion, HBA_STATUS_OK is returned. Otherwise, an error value is returned and the value of EventBufferCount is undefined.

Errors

See libhbaapi(3LIB) for general error status values.

Attributes

See attributes(5) for descriptions of the following attributes:

See Also

HBA_OpenAdapter(3HBAAPI), libhbaapi(3LIB), attributes(5)

T11 FC-MI Specification