GetTcpStatisticsEx function
The GetTcpStatisticsEx function retrieves the Transmission Control Protocol (TCP) statistics for the current computer. The GetTcpStatisticsEx function differs from the GetTcpStatistics function in that GetTcpStatisticsEx also supports the Internet Protocol version 6 (IPv6) protocol family.
Syntax
DWORD GetTcpStatisticsEx( _Out_ PMIB_TCPSTATS pStats, _In_ DWORD dwFamily );
Parameters
- pStats [out]
-
A pointer to a MIB_TCPSTATS structure that receives the TCP statistics for the local computer.
- dwFamily [in]
-
The protocol family for which to retrieve statistics. This parameter must be one of the following values:
Value Meaning - AF_INET
Internet Protocol version 4 (IPv4).
- AF_INET6
Internet Protocol version 6 (IPv6).
Return value
If the function succeeds, the return value is NO_ERROR.
If the function fails, the return value is one of the following error codes.
| Return code | Description |
|---|---|
|
The pStats parameter is NULL or does not point to valid memory, or the dwFamily parameter is not a valid value. |
|
This function is not supported on the operating system on which the function call was made. |
|
Use FormatMessage to obtain the message string for the returned error. |
Requirements
|
Minimum supported client |
Windows XP [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also
- IP Helper Start Page
- IP Helper Function Reference
- GetIpStatisticsEx
- GetTcpStatistics
- GetUdpStatisticsEx
- MIB_TCPSTATS