opensolaris man page for hba_geteventbuffer

HBA_GetEventBuffer(3HBAAPI)		      Common Fibre Channel HBA Information Library Functions		       HBA_GetEventBuffer(3HBAAPI)

NAME
       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  EventBuffer-
       Count 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 unde-
       fined.

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

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

       +-----------------------------+-------------------------------------+
       |      ATTRIBUTE TYPE	     |		ATTRIBUTE VALUE 	   |
       +-----------------------------+-------------------------------------+
       |Interface Stability	     |Standard: FC-MI 1.92 (API version 1) |
       +-----------------------------+-------------------------------------+
       |			     |Standard: FC-HBA Version 4 (API ver- |
       |			     |sion 2)				   |
       +-----------------------------+-------------------------------------+
       |MT-Level		     |Safe				   |
       +-----------------------------+-------------------------------------+

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

       T11 FC-MI Specification

SunOS 5.11							    1 Sep 2003					       HBA_GetEventBuffer(3HBAAPI)