ホーム › NetworkManagement.IpHelper › GetTcpStatistics

GetTcpStatistics

関数

TCPプロトコルの統計情報を取得する。

DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// IPHLPAPI.dll
#include <windows.h>

DWORD GetTcpStatistics(
    MIB_TCPSTATS_LH* Statistics
);

パラメーター

名前	型	方向	説明
Statistics	MIB_TCPSTATS_LH*	out	ローカルコンピューターの TCP 統計情報を受け取る MIB_TCPSTATS 構造体へのポインター。

戻り値の型: DWORD

公式ドキュメント

GetTcpStatistics 関数は、ローカルコンピューターの TCP 統計情報を取得します。

戻り値

関数が成功した場合、戻り値は NO_ERROR です。

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

戻り値	説明
ERROR_INVALID_PARAMETER	pStats パラメーターが NULL であるか、 GetTcpStatistics が pStats パラメーターの指すメモリに書き込めません。
その他	返されたエラーのメッセージ文字列を取得するには、 FormatMessage 関数を使用してください。

解説(Remarks)

GetTcpStatistics 関数は、現在のコンピューターにおける IPv4 の TCP 統計情報を返します。Windows XP 以降では、GetTcpStatisticsEx を使用して、IPv4 または IPv6 の TCP 統計情報を取得できます。

例

次の例では、ローカルコンピューターの TCP 統計情報を取得し、返されたデータからいくつかの値を出力します。

//#include <windows.h>
#include <winsock2.h>
#include <ws2tcpip.h>
#include <iphlpapi.h>
#include <stdio.h>

#pragma comment(lib, "iphlpapi.lib")

#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x)) 
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))

/* Note: could also use malloc() and free() */

int main()
{
    PMIB_TCPSTATS pTCPStats;
    DWORD dwRetVal = 0;

    pTCPStats = (MIB_TCPSTATS*) MALLOC (sizeof(MIB_TCPSTATS));
    if (pTCPStats == NULL) {
        printf("Error allocating memory\n");
        return 1;
    }

    if ((dwRetVal = GetTcpStatistics(pTCPStats)) == NO_ERROR) {
      printf("\tActive Opens: %ld\n", pTCPStats->dwActiveOpens);
      printf("\tPassive Opens: %ld\n", pTCPStats->dwPassiveOpens);
      printf("\tSegments Recv: %ld\n", pTCPStats->dwInSegs);
      printf("\tSegments Xmit: %ld\n", pTCPStats->dwOutSegs);
      printf("\tTotal # Conxs: %ld\n", pTCPStats->dwNumConns);
    }
    else {
      printf("GetTcpStatistics failed with error: %ld\n", dwRetVal);
      
      LPVOID lpMsgBuf;
      if (FormatMessage( FORMAT_MESSAGE_ALLOCATE_BUFFER | 
        FORMAT_MESSAGE_FROM_SYSTEM | 
        FORMAT_MESSAGE_IGNORE_INSERTS,
        NULL,
        dwRetVal,
        MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
        (LPTSTR) &lpMsgBuf,
        0,
        NULL )) {
        printf("\tError: %s", lpMsgBuf);
      }
      LocalFree( lpMsgBuf );
    }

    if (pTCPStats)
        FREE (pTCPStats);
}

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// IPHLPAPI.dll
#include <windows.h>

DWORD GetTcpStatistics(
    MIB_TCPSTATS_LH* Statistics
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetTcpStatistics(
    IntPtr Statistics   // MIB_TCPSTATS_LH* out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetTcpStatistics(
    Statistics As IntPtr   ' MIB_TCPSTATS_LH* out
) As UInteger
End Function

' Statistics : MIB_TCPSTATS_LH* out
Declare PtrSafe Function GetTcpStatistics Lib "iphlpapi" ( _
    ByVal Statistics As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetTcpStatistics = ctypes.windll.iphlpapi.GetTcpStatistics
GetTcpStatistics.restype = wintypes.DWORD
GetTcpStatistics.argtypes = [
    ctypes.c_void_p,  # Statistics : MIB_TCPSTATS_LH* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetTcpStatistics = Fiddle::Function.new(
  lib['GetTcpStatistics'],
  [
    Fiddle::TYPE_VOIDP,  # Statistics : MIB_TCPSTATS_LH* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetTcpStatistics(
        Statistics: *mut MIB_TCPSTATS_LH  // MIB_TCPSTATS_LH* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetTcpStatistics(IntPtr Statistics);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetTcpStatistics' -Namespace Win32 -PassThru
# $api::GetTcpStatistics(Statistics)

#uselib "IPHLPAPI.dll"
#func global GetTcpStatistics "GetTcpStatistics" sptr
; GetTcpStatistics varptr(Statistics)   ; 戻り値は stat
; Statistics : MIB_TCPSTATS_LH* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global GetTcpStatistics "GetTcpStatistics" var
; res = GetTcpStatistics(Statistics)
; Statistics : MIB_TCPSTATS_LH* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global GetTcpStatistics "GetTcpStatistics" sptr
; res = GetTcpStatistics(varptr(Statistics))
; Statistics : MIB_TCPSTATS_LH* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。