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

GetIpInterfaceTable

関数
指定アドレスファミリのIPインターフェイス構成テーブルを取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR GetIpInterfaceTable(
    ADDRESS_FAMILY Family,
    MIB_IPINTERFACE_TABLE** Table
);

パラメーター

名前方向説明
FamilyADDRESS_FAMILYin

取得する IP インターフェイスのアドレスファミリです。

アドレスファミリに指定できる値は Winsock2.h ヘッダーファイルに一覧があります。AF_ アドレスファミリ定数と PF_ プロトコルファミリ定数の値は同一である(たとえば AF_INETPF_INET)ため、どちらの定数も使用できます。

Windows Vista 以降および Windows SDK では、ヘッダーファイルの構成が変更されており、このメンバーに指定できる値は Ws2def.h ヘッダーファイルで定義されています。Ws2def.h ヘッダーファイルは Winsock2.h に自動的にインクルードされるため、直接使用すべきではありません。

現在サポートされている値は AF_INETAF_INET6AF_UNSPEC です。

意味
AF_UNSPEC
0
アドレスファミリは未指定です。このパラメーターを指定すると、GetIpInterfaceTable 関数は IPv4 と IPv6 の両方のエントリを含む IP インターフェイステーブルを返します。
AF_INET
2
インターネットプロトコルバージョン 4 (IPv4) のアドレスファミリです。
AF_INET6
23
インターネットプロトコルバージョン 6 (IPv6) のアドレスファミリです。
TableMIB_IPINTERFACE_TABLE**outMIB_IPINTERFACE_TABLE 構造体で IP インターフェイスエントリのテーブルを受け取るバッファーへのポインターです。

戻り値の型: WIN32_ERROR

公式ドキュメント

ローカルコンピューター上の IP インターフェイスエントリを取得します。

戻り値

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

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

戻り値 説明
ERROR_INVALID_PARAMETER
関数に無効なパラメーターが渡されました。このエラーは、Table パラメーターに NULL ポインターが渡された場合、または Family パラメーターが AF_INETAF_INET6AF_UNSPEC のいずれにも指定されていない場合に返されます。
ERROR_NOT_ENOUGH_MEMORY
操作を完了するために十分なメモリリソースがありません。
ERROR_NOT_FOUND
Family パラメーターで指定された IP インターフェイスエントリが見つかりませんでした。
ERROR_NOT_SUPPORTED
関数はサポートされていません。このエラーは、Address パラメーターで指定された IP トランスポートがローカルコンピューター上で構成されていない場合に返されます。また、この関数がサポートされていないバージョンの Windows でも返されます。
その他
返されたエラーのメッセージ文字列を取得するには、FormatMessage 関数を使用してください。

解説(Remarks)

GetIpInterfaceTable 関数は Windows Vista 以降で定義されています。

GetIpInterfaceTable 関数はローカルシステム上の IP インターフェイスを列挙し、その情報を MIB_IPINTERFACE_TABLE 構造体で返します。

IP インターフェイスエントリは、Table パラメーターが指すバッファー内の MIB_IPINTERFACE_TABLE 構造体で返されます。MIB_IPINTERFACE_TABLE 構造体には、IP インターフェイスエントリの数と、各 IP インターフェイスエントリに対応する MIB_IPINTERFACE_ROW 構造体の配列が含まれます。これらの返された構造体が不要になったら、FreeMibTable を呼び出してメモリを解放してください。

Family パラメーターは AF_INET または AF_INET6 のいずれかに初期化する必要があります。

Table パラメーターが指す、返される MIB_IPINTERFACE_TABLE 構造体には、MIB_IPINTERFACE_TABLE 構造体の NumEntries メンバーと、Table メンバー内の最初の MIB_IPINTERFACE_ROW 配列エントリとの間にアラインメントのためのパディングが含まれる場合があることに注意してください。アラインメントのためのパディングは MIB_IPINTERFACE_ROW 配列エントリ間にも存在する可能性があります。MIB_IPINTERFACE_ROW 配列エントリにアクセスする際は、常にパディングが存在し得ることを前提とすべきです。

次の例では、IP インターフェイステーブルを取得し、テーブル内の IP インターフェイスエントリのいくつかのメンバーの値を表示します。

#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif

#include <windows.h>
#include <winsock2.h>
#include <ws2ipdef.h>
#include <iphlpapi.h>
#include <stdio.h>
#include <stdlib.h>

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

int main()
{
    // Declare and initialize variables

    int i;

    DWORD dwRetVal = 0;

    PMIB_IPINTERFACE_TABLE pipTable = NULL;

    dwRetVal = GetIpInterfaceTable(AF_UNSPEC, &pipTable);
    if (dwRetVal != NO_ERROR) {
        printf("GetIpInterfaceTable returned error: %ld\n", dwRetVal);
        exit(1);
    }
    // Print some variables from the rows in the table
    printf("Number of table entries: %d\n\n", pipTable->NumEntries);

    for (i = 0; i < (int) pipTable->NumEntries; i++) {
        printf("Address Family[%d]:\t\t", i);
        switch (pipTable->Table[i].Family) {
        case AF_INET:
            printf("IPv4\n");
            break;
        case AF_INET6:
            printf("IPv6\n");
            break;
        default:
            printf("Other: %d\n", pipTable->Table[i].Family);
            break;
        }

        printf("Interface LUID NetLuidIndex[%d]:\t %lu\n",
               i, pipTable->Table[i].InterfaceLuid.Info.NetLuidIndex);

        printf("Interface LUID IfType[%d]:\t ", i);
        switch (pipTable->Table[i].InterfaceLuid.Info.IfType) {
        case IF_TYPE_OTHER:
            printf("Other\n");
            break;
        case IF_TYPE_ETHERNET_CSMACD:
            printf("Ethernet\n");
            break;
        case IF_TYPE_ISO88025_TOKENRING:
            printf("Token ring\n");
            break;
        case IF_TYPE_PPP:
            printf("PPP\n");
            break;
        case IF_TYPE_SOFTWARE_LOOPBACK:
            printf("Software loopback\n");
            break;
        case IF_TYPE_ATM:
            printf("ATM\n");
            break;
        case IF_TYPE_IEEE80211:
            printf("802.11 wireless\n");
            break;
        case IF_TYPE_TUNNEL:
            printf("Tunnel encapsulation\n");
            break;
        case IF_TYPE_IEEE1394:
            printf("IEEE 1394 (Firewire)\n");
            break;
        default:
            printf("Unknown: %d\n",
                   pipTable->Table[i].InterfaceLuid.Info.IfType);
            break;
        }
        printf("Interface Index[%d]:\t\t %lu\n",
               i, pipTable->Table[i].InterfaceIndex);
        printf("Maximum reassembly size[%d]:\t %lu\n", i,
               pipTable->Table[i].MaxReassemblySize);

        printf("Advertising enabled[%d]:\t\t ", i);
        if (pipTable->Table[i].AdvertisingEnabled)
            printf("Yes\n");
        else
            printf("No\n");

        printf("Forwarding enabled[%d]:\t\t ", i);
        if (pipTable->Table[i].ForwardingEnabled)
            printf("Yes\n");
        else
            printf("No\n");

        printf("Network layer MTU[%d]:\t\t %lu\n", i, pipTable->Table[i].NlMtu);

        printf("Connected[%d]:\t\t\t ", i);
        if (pipTable->Table[i].Connected)
            printf("Yes\n");
        else
            printf("No\n");

        printf("Supports wakeup patterns[%d]:\t ", i);
        if (pipTable->Table[i].SupportsWakeUpPatterns)
            printf("Yes\n");
        else
            printf("No\n");

        printf("Supports neighbor discovery[%d]:\t ", i);
        if (pipTable->Table[i].SupportsNeighborDiscovery)
            printf("Yes\n");
        else
            printf("No\n");

        printf("Supports router discovery[%d]:\t ", i);
        if (pipTable->Table[i].SupportsRouterDiscovery)
            printf("Yes\n");
        else
            printf("No\n");

        printf("\n");
    }

    FreeMibTable(pipTable);
    pipTable = NULL;

    exit(0);
}

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

各言語での呼び出し定義

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

WIN32_ERROR GetIpInterfaceTable(
    ADDRESS_FAMILY Family,
    MIB_IPINTERFACE_TABLE** Table
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpInterfaceTable(
    ushort Family,   // ADDRESS_FAMILY
    IntPtr Table   // MIB_IPINTERFACE_TABLE** out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpInterfaceTable(
    Family As UShort,   ' ADDRESS_FAMILY
    Table As IntPtr   ' MIB_IPINTERFACE_TABLE** out
) As UInteger
End Function
' Family : ADDRESS_FAMILY
' Table : MIB_IPINTERFACE_TABLE** out
Declare PtrSafe Function GetIpInterfaceTable Lib "iphlpapi" ( _
    ByVal Family As Integer, _
    ByVal Table As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetIpInterfaceTable = ctypes.windll.iphlpapi.GetIpInterfaceTable
GetIpInterfaceTable.restype = wintypes.DWORD
GetIpInterfaceTable.argtypes = [
    ctypes.c_ushort,  # Family : ADDRESS_FAMILY
    ctypes.c_void_p,  # Table : MIB_IPINTERFACE_TABLE** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIpInterfaceTable = iphlpapi.NewProc("GetIpInterfaceTable")
)

// Family (ADDRESS_FAMILY), Table (MIB_IPINTERFACE_TABLE** out)
r1, _, err := procGetIpInterfaceTable.Call(
	uintptr(Family),
	uintptr(Table),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function GetIpInterfaceTable(
  Family: Word;   // ADDRESS_FAMILY
  Table: Pointer   // MIB_IPINTERFACE_TABLE** out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIpInterfaceTable';
result := DllCall("IPHLPAPI\GetIpInterfaceTable"
    , "UShort", Family   ; ADDRESS_FAMILY
    , "Ptr", Table   ; MIB_IPINTERFACE_TABLE** out
    , "UInt")   ; return: WIN32_ERROR
●GetIpInterfaceTable(Family, Table) = DLL("IPHLPAPI.dll", "dword GetIpInterfaceTable(int, void*)")
# 呼び出し: GetIpInterfaceTable(Family, Table)
# Family : ADDRESS_FAMILY -> "int"
# Table : MIB_IPINTERFACE_TABLE** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn GetIpInterfaceTable(
    Family: u16, // ADDRESS_FAMILY
    Table: [*c][*c]MIB_IPINTERFACE_TABLE // MIB_IPINTERFACE_TABLE** out
) callconv(std.os.windows.WINAPI) u32;
proc GetIpInterfaceTable(
    Family: uint16,  # ADDRESS_FAMILY
    Table: ptr MIB_IPINTERFACE_TABLE  # MIB_IPINTERFACE_TABLE** out
): uint32 {.importc: "GetIpInterfaceTable", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetIpInterfaceTable(
    ushort Family,   // ADDRESS_FAMILY
    MIB_IPINTERFACE_TABLE** Table   // MIB_IPINTERFACE_TABLE** out
);
ccall((:GetIpInterfaceTable, "IPHLPAPI.dll"), stdcall, UInt32,
      (UInt16, Ptr{MIB_IPINTERFACE_TABLE}),
      Family, Table)
# Family : ADDRESS_FAMILY -> UInt16
# Table : MIB_IPINTERFACE_TABLE** out -> Ptr{MIB_IPINTERFACE_TABLE}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetIpInterfaceTable(
    uint16_t Family,
    void* Table);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetIpInterfaceTable(Family, Table)
-- Family : ADDRESS_FAMILY
-- Table : MIB_IPINTERFACE_TABLE** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetIpInterfaceTable = lib.func('__stdcall', 'GetIpInterfaceTable', 'uint32_t', ['uint16_t', 'void *']);
// GetIpInterfaceTable(Family, Table)
// Family : ADDRESS_FAMILY -> 'uint16_t'
// Table : MIB_IPINTERFACE_TABLE** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetIpInterfaceTable: { parameters: ["u16", "pointer"], result: "u32" },
});
// lib.symbols.GetIpInterfaceTable(Family, Table)
// Family : ADDRESS_FAMILY -> "u16"
// Table : MIB_IPINTERFACE_TABLE** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetIpInterfaceTable(
    uint16_t Family,
    void* Table);
C, "IPHLPAPI.dll");
// $ffi->GetIpInterfaceTable(Family, Table);
// Family : ADDRESS_FAMILY
// Table : MIB_IPINTERFACE_TABLE** out
// 構造体/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 GetIpInterfaceTable(
        short Family,   // ADDRESS_FAMILY
        Pointer Table   // MIB_IPINTERFACE_TABLE** out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetIpInterfaceTable = GetIpInterfaceTable(
    Family : UInt16,   # ADDRESS_FAMILY
    Table : MIB_IPINTERFACE_TABLE**   # MIB_IPINTERFACE_TABLE** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetIpInterfaceTableNative = Uint32 Function(Uint16, Pointer<Void>);
typedef GetIpInterfaceTableDart = int Function(int, Pointer<Void>);
final GetIpInterfaceTable = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetIpInterfaceTableNative, GetIpInterfaceTableDart>('GetIpInterfaceTable');
// Family : ADDRESS_FAMILY -> Uint16
// Table : MIB_IPINTERFACE_TABLE** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetIpInterfaceTable(
  Family: Word;   // ADDRESS_FAMILY
  Table: Pointer   // MIB_IPINTERFACE_TABLE** out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIpInterfaceTable';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetIpInterfaceTable"
  c_GetIpInterfaceTable :: Word16 -> Ptr () -> IO Word32
-- Family : ADDRESS_FAMILY -> Word16
-- Table : MIB_IPINTERFACE_TABLE** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getipinterfacetable =
  foreign "GetIpInterfaceTable"
    (uint16_t @-> (ptr void) @-> returning uint32_t)
(* Family : ADDRESS_FAMILY -> uint16_t *)
(* Table : MIB_IPINTERFACE_TABLE** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("GetIpInterfaceTable" get-ip-interface-table :convention :stdcall) :uint32
  (family :uint16)   ; ADDRESS_FAMILY
  (table :pointer))   ; MIB_IPINTERFACE_TABLE** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetIpInterfaceTable = Win32::API::More->new('IPHLPAPI',
    'DWORD GetIpInterfaceTable(WORD Family, LPVOID Table)');
# my $ret = $GetIpInterfaceTable->Call($Family, $Table);
# Family : ADDRESS_FAMILY -> WORD
# Table : MIB_IPINTERFACE_TABLE** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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