Manual Pages for UNIX Operating System command usage for man HBA_GetAdapterName

Common Fibre Channel HBA Information Library Functions
                                      HBA_GetAdapterName(3HBAAPI)



NAME
     HBA_GetAdapterName - retrieve the name of a specific HBA

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

     HBA_STATUS HBA_GetAdapterName(HBA_UINT32 adapterindex,
          char *adaptername);


PARAMETERS
     adapterindex    the index of the adapter, between 0 and  one
                     less    than    the    value   returned   by
                     HBA_GetNumberOfAdapters(3HBAAPI).


     adaptername     the buffer where the  name  of  the  adapter
                     will  be stored. The recommended size is 256
                     bytes.


DESCRIPTION
     The HBA_GetAdapterName() function stores  the  name  of  the
     adapter  specified  by adapterindex in the buffer pointed to
     by adaptername.  The caller is  responsible  for  allocating
     space for the name.

RETURN VALUES
     Upon successful completion, HBA_STATUS_OK is returned.  Oth-
     erwise,  an error value is returned and the content of adap-
     tername is undefined.

ERRORS
     See libhbaapi(3LIB) for general error status values.

EXAMPLES
     Example 1 Return adapter name.


     Given an hbacount >= 0 and < total number of adapters on the
     system,  the  following  example returns the adaptername for
     that adapter.


       if ((status = HBA_GetAdapterName(hbaCount, adaptername)) !=
                   HBA_STATUS_OK) {
               fprintf(stderr, "HBA %d name not available for "
                   "reason %d\n", hbaCount, status);
               continue;
       }



SunOS 5.11           Last change: 1 Sep 2003                    1






Common Fibre Channel HBA Information Library Functions
                                      HBA_GetAdapterName(3HBAAPI)



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



     ____________________________________________________________
   |        ATTRIBUTE TYPE       |        ATTRIBUTE VALUE      |
   | ____________________________|_____________________________|_
   |  Interface Stability        |  Committed                  |
   | ____________________________|_____________________________|_
   |                             |  Standard: FC-HBA Version  4|
   |                             |  (API version 2)            |
   |_____________________________|_____________________________|
   | MT-Level                    | Safe                        |
   |_____________________________|_____________________________|
   | Standard                    | FC-MI 1.92 (API version 1)  |
   |_____________________________|_____________________________|


SEE ALSO
      HBA_GetNumberOfAdapters(3HBAAPI),  libhbaapi(3LIB),  attri-
     butes(5)


     T11 FC-MI Specification

BUGS
     The HBA_GetAdapterName()  function  does  not  take  a  name
     length  argument  to define how large the buffer is, yet the
     specification does  not  indicate  a  maximum  name  length.
     Failure  to  pass  in a large enough buffer will result in a
     buffer over-run, which may lead to  segmentation  faults  or
     other  failures.  Callers should be sure to allocate a large
     buffer to ensure the Vendor library will not overrun  during
     the copy.


















SunOS 5.11           Last change: 1 Sep 2003                    2






Common Fibre Channel HBA Information Library Functions
                                      HBA_GetAdapterName(3HBAAPI)






















































SunOS 5.11           Last change: 1 Sep 2003                    3