'\" te
.\" Copyright (c) 2008, 2013, Oracle and/or its affiliates. All rights reserved. 
.TH FCOE_GetPortList 3FCOE "1 Apr 2009" "SunOS 5.11" "FCoE Port Management Library Functions"
.SH NAME
FCOE_GetPortList \- get a list of FCoE ports
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... -lfcoe [ \fIlibrary\fR... ]
#include <libfcoe.h>
.fi

.LP
.nf
\fBFCOE_STATUS\fR \fBFCOE_GetPortList\fR(\fBFCOE_UINT32 *\fR\fIport_num\fR, \fBFCOE_PORT_ATTRIBUTE **\fR\fIportlist\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIport_num\fR\fR
.ad
.RS 12n
.rt  
A pointer to an integer that, on successful return, contains the number of FCoE ports in the system.
.RE

.sp
.ne 2
.mk
.na
\fB\fIportlist\fR\fR
.ad
.RS 12n
.rt  
A pointer to a pointer to an \fBfcoe_port_attr\fR structure that, on successful return, contains a list of the FCoE ports in the system.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBFCOE_GetPortList()\fR function retrieves a list of FCoE ports. When the caller is finished using the list, it must free the memory used by the list by calling \fBfree\fR(3C).
.SH RETURN VALUES
.sp
.LP
The following values are returned:
.sp
.ne 2
.mk
.na
\fB\fBFCOE_STATUS_ERROR_BUSY\fR\fR
.ad
.sp .6
.RS 4n
The \fBfcoe\fR driver is busy and cannot complete the operation.
.RE

.sp
.ne 2
.mk
.na
\fB\fBFCOE_STATUS_ERROR_INVAL_ARG\fR\fR
.ad
.sp .6
.RS 4n
The value specified for \fIport_num\fR or \fIportlist\fR was not valid.
.RE

.sp
.ne 2
.mk
.na
\fB\fBFCOE_STATUS_ERROR_OPEN_DEV\fR\fR
.ad
.sp .6
.RS 4n
Failed to open \fBfcoe\fR device.
.RE

.sp
.ne 2
.mk
.na
\fB\fBFCOE_STATUS_OK\fR\fR
.ad
.sp .6
.RS 4n
The API call was successful.
.RE

.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
_
MT-LevelSafe
.TE

.SH SEE ALSO
.sp
.LP
\fBfree\fR(3C), \fBlibfcoe\fR(3LIB), \fBattributes\fR(5)