usr/src/man/man3fcoe/FCOE_GetPortList.3fcoe

   1 '\" te
   2 .\" Copyright (c) 2009, Sun Microsystems Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH FCOE_GETPORTLIST 3FCOE "Apr 1, 2009"
   7 .SH NAME
   8 FCOE_GetPortList \- get a list of FCoE ports
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... -lfcoe [ \fIlibrary\fR... ]
  13 #include <libfcoe.h>
  14
  15 \fBint\fR \fBFCOE_GetPortList\fR(\fBunsigned int *\fR\fIport_num\fR,
  16      \fBstruct fcoe_port_attr **\fR\fIportlist\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIport_num\fR\fR
  24 .ad
  25 .RS 12n
  26 A pointer to an integer that, on successful return, contains the number of FCoE
  27 ports in the system.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIportlist\fR\fR
  34 .ad
  35 .RS 12n
  36 A pointer to a pointer to an \fBfcoe_port_attr\fR structure that, on successful
  37 return, contains a list of the FCoE ports in the system.
  38 .RE
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The \fBFCOE_GetPortList()\fR function retrieves a list of FCoE ports. When the
  44 caller is finished using the list, it must free the memory used by the list by
  45 calling \fBfree\fR(3C).
  46 .SH RETURN VALUES
  47 .sp
  48 .LP
  49 The following values are returned:
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBFCOE_STATUS_ERROR_BUSY\fR\fR
  54 .ad
  55 .sp .6
  56 .RS 4n
  57 The \fBfcoe\fR driver is busy and cannot complete the operation.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBFCOE_STATUS_ERROR_INVAL_ARG\fR\fR
  64 .ad
  65 .sp .6
  66 .RS 4n
  67 The value specified for \fIport_num\fR or \fIportlist\fR was not valid.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBFCOE_STATUS_ERROR_OPEN_DEV\fR\fR
  74 .ad
  75 .sp .6
  76 .RS 4n
  77 Failed to open \fBfcoe\fR device.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBFCOE_STATUS_OK\fR\fR
  84 .ad
  85 .sp .6
  86 .RS 4n
  87 The API call was successful.
  88 .RE
  89
  90 .SH ATTRIBUTES
  91 .sp
  92 .LP
  93 See \fBattributes\fR(5) for descriptions of the following attributes:
  94 .sp
  95
  96 .sp
  97 .TS
  98 box;
  99 c | c
 100 l | l .
 101 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 102 _
 103 Interface Stability     Committed
 104 _
 105 MT-Level        Safe
 106 .TE
 107
 108 .SH SEE ALSO
 109 .sp
 110 .LP
 111 \fBfree\fR(3C), \fBlibfcoe\fR(3LIB), \fBattributes\fR(5)