HBA_GetFCPStatistics routine
The HBA_GetFCPStatistics routine retrieves traffic statistics that the fibre channel protocol (FCP) has collected for the indicated logical unit.
Syntax
HBA_STATUS HBA_API HBA_GetFCPStatistics(
_In_ HBA_HANDLE handle,
_In_ const HBA_SCSIID *lunit,
_Out_ HBA_FC4STATISTICS *statistics
);
Parameters
handle [in]
Contains a value returned by the routine HBA_OpenAdapter that identifies the HBA on which the port is located.lunit [in]
Contains a structure of type HBA_ScsiId that contains information used by the operating system to identify a SCSI logical unit.statistics [out]
Contains, on return, a structure of type HBA_FC4Statistics that holds the traffic statistics that the FCP protocol has collected for the indicated logical unit.
Return value
The HBA_GetFCPStatistics routine returns a value of type HBA_STATUS that indicates the status of the HBA. In particular, HBA_GetFCPStatistics returns one of the following qualifiers.
| Return code | Description |
|---|---|
| HBA_STATUS_OK | Returned if the FCP statistics were successfully retrieved for the HBA referenced by handle. |
| HBA_STATUS_ERROR_INVALID_LUN | Returned if the HBA referenced by handle is not attached to the logical unit referenced by lunit. |
| HBA_STATUS_ERROR_UNSUPPORTED_FC4 | Returned if the HBA referenced by handle does not support FCP. |
| HBA_STATUS_ERROR | Returned if an unspecified error occurred that prevented the retrieval of the statistics. |
Remarks
Statistics counters in HBA_FC4Statistics are 64-bit signed integers that wrap to zero on exceeding 2**63-1. If an HBA does not support a specific statistic, it returns a value with every bit set to 1 for that statistic. For an explanation of how the counter values are determined, see the T11 committee's Fibre Channel Generic Services - 4 specification.
Requirements
Target platform |
Desktop |
Header |
Hbaapi.h (include Hbaapi.h) |
Library |
Hbaapi.lib |
DLL |
Hbaapi.dll |
See also