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

NAME

       HBA_GetBindingCapability, HBA_GetBindingSupport, HBA_SetBindingSupport - return and sets binding capabilities on an HBA port

SYNOPSIS

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

       HBA_HANDLE HBA_GetBindingCapability(HBA_HANDLE handle,
	    HBA_WWN hbaPortWWN, HBA_BIND_CAPABILITY *pFlags);

       HBA_STATUS HBA_GetBindingSupport(HBA_HANDLE handle, HBA_WWN
	    hbaPortWWN, HBA_BIND_CAPABILITY *pFlags);

       void HBA_SetBindingSupport(HBA_HANDLE handle, HBA_WWN hbaPortWWN,
	    HBA_BIND_CAPABILITY Flags);

PARAMETERS

       handle	     an open handle returned from HBA_OpenAdapter(3HBAAPI)

       hbaPortWWN    the Port WWN of the local HBA through which the binding capabilities implemented by the HBA is returned

       pFlags	     a pointer to an HBA_BIND_CAPABILITY structure that returns the persistent binding capabilites implemented by the HBA

       Flags	     an HBA_BIND_CAPABILITY structure containing the persistent binding capabilites to enable for the HBA

DESCRIPTION

       The HBA_GetBindingCapability() function returns the binding capabilities implemented by the HBA.

       The HBA_GetBindingSupport() function returns the currently enabled binding capabilities for the HBA.

       The  HBA_SetBindingSupport()  function  sets  the currently enabled binding capabilites for the HBA to a subset of the binding capabilities
       implemented by the HBA.

RETURN VALUES

       The HBA_GetBindingCapability() and HBA_GetBindingSupport() functions return the following values:

       HBA_STATUS_OK

	   Persistent binding capabilites have been returned.

       HBA_STATUS_ERROR_ILLEGAL_WWN

	   Port WWN hbaPortWWN is not a WWN contained by the HBA referenced by handle.

       HBA_STATUS_ERROR_NOT_SUPPORTED

	   The HBA handle specified by handle does not support persistent binding.

       HBA_STATUS_ERROR

	   An error occurred. The value of pFlags remains unchanged and points to the persistent binding capabilites.

       The HBA_SetBindingSupport() function returns:

       HBA_STATUS_OK

	   Persistent binding capabilites have been enabled.

       HBA_STATUS_ERROR_ILLEGAL_WWN

	   Port WWN hbaPortWWN is not a WWN contained by the HBA referenced by handle.

       HBA_STATUS_ERROR_NOT_SUPPORTED

	   The HBA handle specified by handle does not support persistent binding.

       HBA_STATUS_ERROR_INCAPABLE

	   The flags argument contains a capability not implemented by the HBA.

       HBA_STATUS_ERROR

	   An error occurred.

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

       libhbaapi(3LIB), attributes(5)

       T11 FC-MI Specification

SunOS 5.11							    1 Sep 2003					 HBA_GetBindingCapability(3HBAAPI)