HBA_GetFC4Statistics routine

Article
10/05/2017

The HBA_GetFC4Statistics routine retrieves traffic statistics that a specific FC-4 protocol has collected for the indicated port and local adapter.

Syntax

HBA_STATUS HBA_API HBA_GetFC4Statistics(
  _In_  HBA_HANDLE        handle,
  _In_  HBA_WWN           portWWN,
  _In_  HBA_UINT8         FC4type,
  _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.
portWWN [in]
Contains a 64-bit world-wide name (WWN) that uniquely identifies the local HBA port for which this routine retrieves traffic statistics for a specific FC-4 protocol. For a discussion of worldwide names, see the T11 committee's Fibre Channel HBA API specification.
FC4type [in]
Contains a value that indicates the type FC-4 protocol. For an explanation of FC4 types and the values that can be assigned to this parameter, see the T11 committee's Fibre Channel Generic Services - 4 specification.
statistics [out]
Pointer to a structure of type HBA_FC4Statistics that contains statistics for the specified port and FC-4 protocol.

Return value

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

Return code	Description
HBA_STATUS_ERROR_ILLEGAL_WWN	Returned if the adapter does not contain a port with the name HbaPortWWN.
HBA_STATUS_ERROR_NOT_SUPPORTED	Returned if the adapter does not support the specified FC-4 protocol.
HBA_STATUS_ERROR	Returned if an unspecified error occurred that prevented the retrieval of the port attributes.

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

Share via