Win32 API 日本語リファレンス
ホームNetworkManagement.IpHelper › GetTcpTable

GetTcpTable

関数
現在のTCP接続一覧をMIB_TCPTABLEとして取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetTcpTable(
    MIB_TCPTABLE* TcpTable,   // optional
    DWORD* SizePointer,
    BOOL Order
);

パラメーター

名前方向説明
TcpTableMIB_TCPTABLE*outoptionalTCP 接続テーブルを MIB_TCPTABLE 構造体として受け取るバッファーへのポインターです。
SizePointerDWORD*inout

入力時には、pTcpTable パラメーターが指すバッファーのサイズをバイト単位で指定します。

出力時には、返される接続テーブルを格納するにはバッファーが十分大きくない場合、この関数はこのパラメーターに必要なバッファーサイズ(バイト単位)を設定します。

Windows Vista 以降向けにリリースされた Windows SDK では、このパラメーターのデータ型は PDWORD と同等の PULONG に変更されています。

OrderBOOLin

TCP 接続テーブルをソートするかどうかを指定するブール値です。このパラメーターが TRUE の場合、テーブルは次の順序でソートされます。

  1. ローカル IP アドレス
  2. ローカルポート
  3. リモート IP アドレス
  4. リモートポート

戻り値の型: DWORD

公式ドキュメント

IPv4 の TCP 接続テーブルを取得します。(GetTcpTable)

戻り値

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

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

戻り値 説明
ERROR_INSUFFICIENT_BUFFER
pTcpTable パラメーターが指すバッファーが十分大きくありません。必要なサイズは pdwSize パラメーターが指す DWORD 変数に返されます。

このエラーは、pTcpTable パラメーターが NULL の場合にも返されます。

ERROR_INVALID_PARAMETER
pdwSize パラメーターが NULL であるか、 GetTcpTablepdwSize パラメーターの指すメモリに書き込めません。
ERROR_NOT_SUPPORTED
この関数は、ローカルシステムで使用されているオペレーティングシステムではサポートされていません。
STATUS_UNSUCCESSFUL
この戻り値を受け取った場合は、通常、関数を再度呼び出すだけで問題が解消され、目的の結果が得られます。この戻り値は、システムが高負荷状態にあることが原因で発生する場合があります。たとえば、TCP 接続テーブルのサイズが 3 回連続して 2 項目を超えて増加した場合などです。
その他
返されたエラーに対応するメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

Windows Vista 以降向けにリリースされた Windows SDK では、GetTcpTable 関数の戻り値のデータ型は DWORD と同等の ULONG に変更されています。

次の例は、IPv4 の TCP 接続テーブルを取得し、各接続の状態を出力します。

// Need to link with Iphlpapi.lib and Ws2_32.lib
#include <winsock2.h>
#include <ws2tcpip.h>
#include <iphlpapi.h>
#include <stdio.h>

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

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

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

int main()
{

    // Declare and initialize variables
    PMIB_TCPTABLE pTcpTable;
    DWORD dwSize = 0;
    DWORD dwRetVal = 0;

    char szLocalAddr[128];
    char szRemoteAddr[128];

    struct in_addr IpAddr;

    int i;

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

    dwSize = sizeof (MIB_TCPTABLE);
// Make an initial call to GetTcpTable to
// get the necessary size into the dwSize variable
    if ((dwRetVal = GetTcpTable(pTcpTable, &dwSize, TRUE)) ==
        ERROR_INSUFFICIENT_BUFFER) {
        FREE(pTcpTable);
        pTcpTable = (MIB_TCPTABLE *) MALLOC(dwSize);
        if (pTcpTable == NULL) {
            printf("Error allocating memory\n");
            return 1;
        }
    }
// Make a second call to GetTcpTable to get
// the actual data we require
    if ((dwRetVal = GetTcpTable(pTcpTable, &dwSize, TRUE)) == NO_ERROR) {
        printf("\tNumber of entries: %d\n", (int) pTcpTable->dwNumEntries);
        for (i = 0; i < (int) pTcpTable->dwNumEntries; i++) {
            IpAddr.S_un.S_addr = (u_long) pTcpTable->table[i].dwLocalAddr;
            strcpy_s(szLocalAddr, sizeof (szLocalAddr), inet_ntoa(IpAddr));
            IpAddr.S_un.S_addr = (u_long) pTcpTable->table[i].dwRemoteAddr;
            strcpy_s(szRemoteAddr, sizeof (szRemoteAddr), inet_ntoa(IpAddr));

            printf("\n\tTCP[%d] State: %ld - ", i,
                   pTcpTable->table[i].dwState);
            switch (pTcpTable->table[i].dwState) {
            case MIB_TCP_STATE_CLOSED:
                printf("CLOSED\n");
                break;
            case MIB_TCP_STATE_LISTEN:
                printf("LISTEN\n");
                break;
            case MIB_TCP_STATE_SYN_SENT:
                printf("SYN-SENT\n");
                break;
            case MIB_TCP_STATE_SYN_RCVD:
                printf("SYN-RECEIVED\n");
                break;
            case MIB_TCP_STATE_ESTAB:
                printf("ESTABLISHED\n");
                break;
            case MIB_TCP_STATE_FIN_WAIT1:
                printf("FIN-WAIT-1\n");
                break;
            case MIB_TCP_STATE_FIN_WAIT2:
                printf("FIN-WAIT-2 \n");
                break;
            case MIB_TCP_STATE_CLOSE_WAIT:
                printf("CLOSE-WAIT\n");
                break;
            case MIB_TCP_STATE_CLOSING:
                printf("CLOSING\n");
                break;
            case MIB_TCP_STATE_LAST_ACK:
                printf("LAST-ACK\n");
                break;
            case MIB_TCP_STATE_TIME_WAIT:
                printf("TIME-WAIT\n");
                break;
            case MIB_TCP_STATE_DELETE_TCB:
                printf("DELETE-TCB\n");
                break;
            default:
                printf("UNKNOWN dwState value\n");
                break;
            }
            printf("\tTCP[%d] Local Addr: %s\n", i, szLocalAddr);
            printf("\tTCP[%d] Local Port: %d \n", i,
                   ntohs((u_short)pTcpTable->table[i].dwLocalPort));
            printf("\tTCP[%d] Remote Addr: %s\n", i, szRemoteAddr);
            printf("\tTCP[%d] Remote Port: %d\n", i,
                   ntohs((u_short)pTcpTable->table[i].dwRemotePort));
        }
    } else {
        printf("\tGetTcpTable failed with %d\n", dwRetVal);
        FREE(pTcpTable);
        return 1;
    }

    if (pTcpTable != NULL) {
        FREE(pTcpTable);
        pTcpTable = NULL;
    }    

    return 0;    
}

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

各言語での呼び出し定義

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

DWORD GetTcpTable(
    MIB_TCPTABLE* TcpTable,   // optional
    DWORD* SizePointer,
    BOOL Order
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetTcpTable(
    IntPtr TcpTable,   // MIB_TCPTABLE* optional, out
    ref uint SizePointer,   // DWORD* in/out
    bool Order   // BOOL
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetTcpTable(
    TcpTable As IntPtr,   ' MIB_TCPTABLE* optional, out
    ByRef SizePointer As UInteger,   ' DWORD* in/out
    Order As Boolean   ' BOOL
) As UInteger
End Function
' TcpTable : MIB_TCPTABLE* optional, out
' SizePointer : DWORD* in/out
' Order : BOOL
Declare PtrSafe Function GetTcpTable Lib "iphlpapi" ( _
    ByVal TcpTable As LongPtr, _
    ByRef SizePointer As Long, _
    ByVal Order As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetTcpTable = ctypes.windll.iphlpapi.GetTcpTable
GetTcpTable.restype = wintypes.DWORD
GetTcpTable.argtypes = [
    ctypes.c_void_p,  # TcpTable : MIB_TCPTABLE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # SizePointer : DWORD* in/out
    wintypes.BOOL,  # Order : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetTcpTable = Fiddle::Function.new(
  lib['GetTcpTable'],
  [
    Fiddle::TYPE_VOIDP,  # TcpTable : MIB_TCPTABLE* optional, out
    Fiddle::TYPE_VOIDP,  # SizePointer : DWORD* in/out
    Fiddle::TYPE_INT,  # Order : BOOL
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn GetTcpTable(
        TcpTable: *mut MIB_TCPTABLE,  // MIB_TCPTABLE* optional, out
        SizePointer: *mut u32,  // DWORD* in/out
        Order: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetTcpTable(IntPtr TcpTable, ref uint SizePointer, bool Order);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetTcpTable' -Namespace Win32 -PassThru
# $api::GetTcpTable(TcpTable, SizePointer, Order)
#uselib "IPHLPAPI.dll"
#func global GetTcpTable "GetTcpTable" sptr, sptr, sptr
; GetTcpTable varptr(TcpTable), varptr(SizePointer), Order   ; 戻り値は stat
; TcpTable : MIB_TCPTABLE* optional, out -> "sptr"
; SizePointer : DWORD* in/out -> "sptr"
; Order : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IPHLPAPI.dll"
#cfunc global GetTcpTable "GetTcpTable" var, var, int
; res = GetTcpTable(TcpTable, SizePointer, Order)
; TcpTable : MIB_TCPTABLE* optional, out -> "var"
; SizePointer : DWORD* in/out -> "var"
; Order : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetTcpTable(MIB_TCPTABLE* TcpTable, DWORD* SizePointer, BOOL Order)
#uselib "IPHLPAPI.dll"
#cfunc global GetTcpTable "GetTcpTable" var, var, int
; res = GetTcpTable(TcpTable, SizePointer, Order)
; TcpTable : MIB_TCPTABLE* optional, out -> "var"
; SizePointer : DWORD* in/out -> "var"
; Order : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetTcpTable = iphlpapi.NewProc("GetTcpTable")
)

// TcpTable (MIB_TCPTABLE* optional, out), SizePointer (DWORD* in/out), Order (BOOL)
r1, _, err := procGetTcpTable.Call(
	uintptr(TcpTable),
	uintptr(SizePointer),
	uintptr(Order),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetTcpTable(
  TcpTable: Pointer;   // MIB_TCPTABLE* optional, out
  SizePointer: Pointer;   // DWORD* in/out
  Order: BOOL   // BOOL
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetTcpTable';
result := DllCall("IPHLPAPI\GetTcpTable"
    , "Ptr", TcpTable   ; MIB_TCPTABLE* optional, out
    , "Ptr", SizePointer   ; DWORD* in/out
    , "Int", Order   ; BOOL
    , "UInt")   ; return: DWORD
●GetTcpTable(TcpTable, SizePointer, Order) = DLL("IPHLPAPI.dll", "dword GetTcpTable(void*, void*, bool)")
# 呼び出し: GetTcpTable(TcpTable, SizePointer, Order)
# TcpTable : MIB_TCPTABLE* optional, out -> "void*"
# SizePointer : DWORD* in/out -> "void*"
# Order : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn GetTcpTable(
    TcpTable: [*c]MIB_TCPTABLE, // MIB_TCPTABLE* optional, out
    SizePointer: [*c]u32, // DWORD* in/out
    Order: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
proc GetTcpTable(
    TcpTable: ptr MIB_TCPTABLE,  # MIB_TCPTABLE* optional, out
    SizePointer: ptr uint32,  # DWORD* in/out
    Order: int32  # BOOL
): uint32 {.importc: "GetTcpTable", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetTcpTable(
    MIB_TCPTABLE* TcpTable,   // MIB_TCPTABLE* optional, out
    uint* SizePointer,   // DWORD* in/out
    int Order   // BOOL
);
ccall((:GetTcpTable, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{MIB_TCPTABLE}, Ptr{UInt32}, Int32),
      TcpTable, SizePointer, Order)
# TcpTable : MIB_TCPTABLE* optional, out -> Ptr{MIB_TCPTABLE}
# SizePointer : DWORD* in/out -> Ptr{UInt32}
# Order : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetTcpTable(
    void* TcpTable,
    uint32_t* SizePointer,
    int32_t Order);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetTcpTable(TcpTable, SizePointer, Order)
-- TcpTable : MIB_TCPTABLE* optional, out
-- SizePointer : DWORD* in/out
-- Order : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetTcpTable = lib.func('__stdcall', 'GetTcpTable', 'uint32_t', ['void *', 'uint32_t *', 'int32_t']);
// GetTcpTable(TcpTable, SizePointer, Order)
// TcpTable : MIB_TCPTABLE* optional, out -> 'void *'
// SizePointer : DWORD* in/out -> 'uint32_t *'
// Order : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetTcpTable: { parameters: ["pointer", "pointer", "i32"], result: "u32" },
});
// lib.symbols.GetTcpTable(TcpTable, SizePointer, Order)
// TcpTable : MIB_TCPTABLE* optional, out -> "pointer"
// SizePointer : DWORD* in/out -> "pointer"
// Order : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetTcpTable(
    void* TcpTable,
    uint32_t* SizePointer,
    int32_t Order);
C, "IPHLPAPI.dll");
// $ffi->GetTcpTable(TcpTable, SizePointer, Order);
// TcpTable : MIB_TCPTABLE* optional, out
// SizePointer : DWORD* in/out
// Order : BOOL
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Iphlpapi extends StdCallLibrary {
    Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
    int GetTcpTable(
        Pointer TcpTable,   // MIB_TCPTABLE* optional, out
        IntByReference SizePointer,   // DWORD* in/out
        boolean Order   // BOOL
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetTcpTable = GetTcpTable(
    TcpTable : MIB_TCPTABLE*,   # MIB_TCPTABLE* optional, out
    SizePointer : UInt32*,   # DWORD* in/out
    Order : Int32   # BOOL
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetTcpTableNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Int32);
typedef GetTcpTableDart = int Function(Pointer<Void>, Pointer<Uint32>, int);
final GetTcpTable = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetTcpTableNative, GetTcpTableDart>('GetTcpTable');
// TcpTable : MIB_TCPTABLE* optional, out -> Pointer<Void>
// SizePointer : DWORD* in/out -> Pointer<Uint32>
// Order : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetTcpTable(
  TcpTable: Pointer;   // MIB_TCPTABLE* optional, out
  SizePointer: Pointer;   // DWORD* in/out
  Order: BOOL   // BOOL
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetTcpTable';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetTcpTable"
  c_GetTcpTable :: Ptr () -> Ptr Word32 -> CInt -> IO Word32
-- TcpTable : MIB_TCPTABLE* optional, out -> Ptr ()
-- SizePointer : DWORD* in/out -> Ptr Word32
-- Order : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let gettcptable =
  foreign "GetTcpTable"
    ((ptr void) @-> (ptr uint32_t) @-> int32_t @-> returning uint32_t)
(* TcpTable : MIB_TCPTABLE* optional, out -> (ptr void) *)
(* SizePointer : DWORD* in/out -> (ptr uint32_t) *)
(* Order : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("GetTcpTable" get-tcp-table :convention :stdcall) :uint32
  (tcp-table :pointer)   ; MIB_TCPTABLE* optional, out
  (size-pointer :pointer)   ; DWORD* in/out
  (order :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetTcpTable = Win32::API::More->new('IPHLPAPI',
    'DWORD GetTcpTable(LPVOID TcpTable, LPVOID SizePointer, BOOL Order)');
# my $ret = $GetTcpTable->Call($TcpTable, $SizePointer, $Order);
# TcpTable : MIB_TCPTABLE* optional, out -> LPVOID
# SizePointer : DWORD* in/out -> LPVOID
# Order : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型