hba_getadaptername(3hbaapi) [opensolaris man page]

HBA_GetAdapterName(3HBAAPI)		      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 <hbaapi.h>

       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. Otherwise, an error value is returned and the content of adaptername 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
", hbaCount, status);
		 continue;
	 }

ATTRIBUTES

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

       +-----------------------------+-------------------------------------+
       |      ATTRIBUTE TYPE	     |		ATTRIBUTE VALUE 	   |
       +-----------------------------+-------------------------------------+
       |Interface Stability	     |Standard: FC-MI 1.92 (API version 1) |
       +-----------------------------+-------------------------------------+
       |			     |Standard: FC-HBA Version 4 (API ver- |
       |			     |sion 2)				   |
       +-----------------------------+-------------------------------------+
       |MT-Level		     |Safe				   |
       +-----------------------------+-------------------------------------+

SEE ALSO

	HBA_GetNumberOfAdapters(3HBAAPI), libhbaapi(3LIB), attributes(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							    1 Sep 2003					       HBA_GetAdapterName(3HBAAPI)

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

NAME

       HBA_OpenAdapter, HBA_OpenAdapterByWWN, HBA_CloseAdapter - open and close a specific adapter

SYNOPSIS

       cc [ flag... ] file... -lHBAAPI [ library... ]
       #include <hbaapi.h>

       HBA_HANDLE HBA_OpenAdapter(char *adaptername);

       HBA_STATUS HBA_OpenAdapterByWWN(HBA_HANDLE *handle, HBA_WWN wwn);

       void HBA_CloseAdapter(HBA_HANDLE handle);

PARAMETERS

       adaptername     the name of the adapter to open, as returned by HBA_GetAdapterName(3HBAAPI)

       handle
                       HBA_OpenAdapterByWWN()

                           a pointer to an HBA_HANDLE

                       HBA_CloseAdapter()

                           the open handle of the adapter to close, as returned by HBA_OpenAdapter(3HBAAPI)

       wwn             the WWN to match the Node WWN or Port WWN of the HBA to open

DESCRIPTION

       The HBA_OpenAdapter() function opens the adapter specified by adaptername and returns a handle used for subsequent operations on the HBA.

       The HBA_OpenAdapterByWWN() function opens a handle to the HBA whose Node or Port WWN matches the wwn argument.

       The HBA_CloseAdapter() function closes the open handle.

RETURN VALUES

       Upon successful completion, HBA_OpenAdapter() returns a valid HBA_HANDLE with a numeric value greater than 0. Otherwise, 0 is returned.

       The HBA_OpenAdapterByWWN() function returns the following values:

       HBA_STATUS_OK

           The handle argument contains a valid HBA handle.

       HBA_STATUS_ERROR_ILLEGAL_WWN

           The wwn argument is not a valid port WWN on the specified HBA.

       HBA_STATUS_ERROR_AMBIGUOUS_WWN

           The WWN is matched to multiple adapters.

       HBA_STATUS_ERROR

           An error occurred while opening the adapter.

EXAMPLES

       Example 1: Open an adapter.

       The following example opens the specified adapter.

       handle = HBA_OpenAdapter(adaptername);
       if (handle == 0) {
           fprintf(stderr, "Unable to open HBA %d with name "
               ""%s".
", hbaCount, adaptername);
           continue;
       }

ATTRIBUTES

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

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

SEE ALSO

       HBA_GetAdapterName(3HBAAPI), HBA_OpenAdapter(3HBAAPI), libhbaapi(3LIB), attributes(5)

       T11 FC-MI Specification

SunOS 5.10                                                          1 Sep 2003                                            HBA_OpenAdapter(3HBAAPI)