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)