man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: July 2014
 
 

FCOE_GetPortList(3FCOE)

Name

FCOE_GetPortList - get a list of FCoE ports

Synopsis

cc [ flag... ] file... -lfcoe [ 
library... ]
#include <libfcoe.h>


FCOE_STATUS FCOE_GetPortList(
FCOE_UINT32 *port_num, FCOE_PORT_ATTRIBUTE **
portlist);

Parameters

port_num

A pointer to an integer that, on successful return, contains the number of FCoE ports in the system.

portlist

A pointer to a pointer to an fcoe_port_attr structure that, on successful return, contains a list of the FCoE ports in the system.

Description

The FCOE_GetPortList() 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 free (3C).

Return Values

The following values are returned:

FCOE_STATUS_ERROR_BUSY

The fcoe driver is busy and cannot complete the operation.

FCOE_STATUS_ERROR_INVAL_ARG

The value specified for port_num or portlist was not valid.

FCOE_STATUS_ERROR_OPEN_DEV

Failed to open fcoe device.

FCOE_STATUS_OK

The API call was successful.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe

See Also

free(3C) , libfcoe (3LIB), attributes(5)