'\" te
.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
.TH HBA_GetEventBuffer 3HBAAPI "1 Sep 2003" "SunOS 5.11" "Common Fibre Channel HBA Information Library Functions"
.SH NAME
HBA_GetEventBuffer \- remove and return the next event from the HBA's event queue
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lHBAAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <hbaapi.h>

\fBHBA_STATUS\fR \fBHBA_GetEventBuffer\fR(\fBHBA_HANDLE\fR \fIhandle\fR,
     \fBHBA_EVENTINFO *\fR\fIEventBuffer\fR, \fBHBA_UINT32 *\fR\fIEventBufferCount\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIhandle\fR\fR
.ad
.RS 20n
.rt  
an open handle returned from \fBHBA_OpenAdapter\fR(3HBAAPI)
.RE

.sp
.ne 2
.mk
.na
\fB\fIEventBuffer\fR\fR
.ad
.RS 20n
.rt  
a pointer to an \fBHBA_EVENTINFO\fR buffer
.RE

.sp
.ne 2
.mk
.na
\fB\fIEventBufferCount\fR\fR
.ad
.RS 20n
.rt  
a pointer to the maximum number of events that can be stored in the \fBHBA_EVENTINFO\fR buffer. The value will be changed to the actual number of events placed in the buffer on completion.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBHBA_GetEventBuffer()\fR function retrieves events from the HBA's event queue. The number of events returned is the lesser of \fIEventBufferCount\fR and the number of events on the queue. The returned events are removed from the queue.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fBHBA_STATUS_OK\fR is returned. Otherwise, an error value is returned and the value of \fIEventBufferCount\fR is undefined.
.SH ERRORS
.sp
.LP
See \fBlibhbaapi\fR(3LIB) for general error status values.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5)  for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
T{
Standard: FC-HBA Version 4 (API version 2)
T}
_
MT-LevelSafe
_
StandardFC-MI 1.92 (API version 1)
.TE

.SH SEE ALSO
.sp
.LP
\fBHBA_OpenAdapter\fR(3HBAAPI), \fBlibhbaapi\fR(3LIB), \fBattributes\fR(5)
.sp
.LP
T11 FC-MI Specification