Manual Pages for UNIX Operating System command usage for man FCOE_GetPortList

FCoE Port Management Library Functions    FCOE_GetPortList(3FCOE)



NAME
     FCOE_GetPortList - get a list of FCoE ports

SYNOPSIS
     cc [ flag... ] file... -lfcoe [ library... ]
     #include 

     int FCOE_GetPortList(unsigned int *port_num,
          struct fcoe_port_attr **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  opera-
         tion.


     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.





SunOS 5.11           Last change: 1 Apr 2009                    1






FCoE Port Management Library Functions    FCOE_GetPortList(3FCOE)



ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | Safe                        |
    |_____________________________|_____________________________|


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






































SunOS 5.11           Last change: 1 Apr 2009                    2