Export (0) Print
Expand All
Expand Minimize

HBA_GetFcpPersistentBinding routine

The HBA_GetFcpPersistentBinding routine retrieves the persistent bindings that are associated with the logical units that the HBA can enumerate.

Syntax


HBA_STATUS HBA_API HBA_GetFcpPersistentBinding(
  _In_     HBA_HANDLE Handle,
  _Inout_  PHBA_FCPBINDING Binding
);

Parameters

Handle [in]

Contains a value returned by the routine HBA_OpenAdapter that identifies the HBA to query for the bindings. The HBA returns bindings for the targets that it can enumerate.

Binding [in, out]

Contains a structure of type HBA_FCPBinding that holds an array of elements of type HBA_FCPBindingEntry, each of which holds a persistent binding between operating system and fibre channel protocol (FCP) identifiers for a logical unit. On input, the NumberOfEntries member of HBA_FCPBinding should contain the number of bindings that fit in the output buffer. On output, NumberOfEntries holds the number of entries actually returned, which is equal to the number specified on input, or the full set of available bindings, whichever is smaller. The value in NumberOfEntries will contain the number of persistent bindings returned even when an error occurred because of insufficient buffer space.

Return value

The HBA_GetFcpPersistentBinding routine returns a value of type HBA_STATUS that indicates the status of the HBA. In particular, HBA_GetFcpPersistentBinding returns one of the following qualifiers.

Return codeDescription
HBA_STATUS_OK

Returned if the persistent bindings were successfully retrieved.

HBA_STATUS_ERROR_NOT_SUPPORTED

Returned if the adapter referenced by HbaHandle does not support persistent binding.

HBA_STATUS_ERROR_MORE_DATA

Returned if a larger buffer is required to contain binding information.

HBA_STATUS_ERROR

Returned if an unspecified error occurred that prevented the retrieval of the persistent bindings.

 

Remarks

The HBA_GetFcpPersistentBinding routine retrieves a set of bindings between operating system and fibre channel protocol (FCP) identifiers for the logical units that it can enumerate. These bindings persist across reboots of the operating system.

Requirements

Header

Hbaapi.h (include Hbaapi.h)

Library

Hbaapi.lib

See also

HBA_FCPBinding
HBA_OpenAdapter
HBA_STATUS

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft