Current File : //usr/share/man/man3hbaapi/HBA_GetAdapterAttributes.3hbaapi

'\" te
.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
.TH HBA_GetAdapterAttributes 3HBAAPI "1 Sep 2003" "SunOS 5.11" "Common Fibre Channel HBA Information Library Functions"
.SH NAME
HBA_GetAdapterAttributes \- retrieve attributes about a specific HBA
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lHBAAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
#include <hbaapi.h>

\fBHBA_STATUS\fR \fBHBA_GetAdapterAttributes\fR(\fBHBA_HANDLE\fR \fIhandle\fR,
     \fBHBA_ADAPTERATTRIBUTES *\fR\fIhbaattributes\fR);
.fi

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

.sp
.ne 2
.mk
.na
\fB\fIhbaattributes\fR\fR
.ad
.RS 17n
.rt  
a pointer to an \fBHBA_ADAPTERATTRIBUTES\fR structure. Upon successful completion, this structure contains the specified adapter attributes.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBHBA_GetAdapterAttributes()\fR function retrieves the adapter attributes structure for a given HBA.  The caller is responsible for allocating \fIhbaattributes\fR.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fBHBA_STATUS_OK\fR is returned. Otherwise, an error value is returned and the values in \fIhbaattributes\fR are undefined.
.SH ERRORS
.sp
.LP
See \fBlibhbaapi\fR(3LIB) for general error status values.
.SH EXAMPLES
.LP
\fBExample 1 \fRReturn adapter attributes.
.sp
.LP
The following example returns the adapter attributes into hbaAttrs for the given handle.

.sp
.in +2
.nf
if ((status = HBA_GetAdapterAttributes(handle, &hbaAttrs)) != 
                  HBA_STATUS_OK) {
        fprintf(stderr, "Unable to get adapter attributes for "
               "HBA %d with name \e"%s\e".\en", hbaCount, adaptername);
        HBA_CloseAdapter(handle);
        continue;
}
.fi
.in -2

.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