HBA_GetAdapterPortAttributes routine
The HBA_GetAdapterPortAttributes routine retrieves the attributes for a specified remote fibre channel port.
Syntax
HBA_STATUS HBA_API HBA_GetAdapterPortAttributes(
_In_ HBA_HANDLE HbaHandle,
_In_ HBA_UINT32 PortIndex,
_Out_ HBA_PORTATTRIBUTES *PortAttributes
);
Parameters
HbaHandle [in]
Contains a value returned by the routine HBA_OpenAdapter that identifies the HBA on which the port is located.PortIndex [in]
Indicates which remote port to query on the HBA specified by HbaHandle.PortAttributes [out]
Pointer to a structure of type HBA_PortAttributes that, on return, contains the attributes of the remote port with an index of PortIndex on the HBA specified by HbaHandle.
Return value
The HBA_GetAdapterPortAttributes routine returns a value of type HBA_STATUS that indicates the status of the HBA. A value of HBA_STATUS_OK indicates that the operation succeeded. A value of HBA_STATUS_ERROR indicates that an unspecified error occurred that prevented the retrieval of the port attributes.
Remarks
The HBA_GetAdapterPortAttributes routine retrieves attributes for remote ports of type Nx_Port. For a definition of Nx_Port, see the T11 committee's specification for Fibre Channel HBA API.
Requirements
Target platform |
Desktop |
Header |
Hbaapi.h (include Hbaapi.h) |
Library |
Hbaapi.lib |
DLL |
Hbaapi.dll |
See also