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

GetIfTable

関数
ローカルマシンのネットワークインターフェイス一覧をMIB_IFTABLEで取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetIfTable(
    MIB_IFTABLE* pIfTable,   // optional
    DWORD* pdwSize,
    BOOL bOrder
);

パラメーター

名前方向説明
pIfTableMIB_IFTABLE*outoptionalインターフェイス テーブルを MIB_IFTABLE 構造体として受け取るバッファーへのポインターです。
pdwSizeDWORD*inout

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

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

bOrderBOOLin返されるインターフェイス テーブルをインターフェイス インデックスの昇順で並べ替えるかどうかを指定するブール値です。このパラメーターが TRUE の場合、テーブルは並べ替えられます。

戻り値の型: DWORD

公式ドキュメント

GetIfTable 関数は、MIB-II インターフェイス テーブルを取得します。

戻り値

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

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

戻り値 説明
ERROR_INSUFFICIENT_BUFFER
pIfTable パラメーターが指すバッファーが十分な大きさではありません。必要なサイズは、pdwSize パラメーターが指す DWORD 変数に返されます。
ERROR_INVALID_PARAMETER
pdwSize パラメーターが NULL であるか、 GetIfTablepdwSize パラメーターの指すメモリに書き込めません。
ERROR_NOT_SUPPORTED
この関数は、ローカル システムで使用しているオペレーティング システムではサポートされていません。
その他
FormatMessage 関数を使用して、返されたエラーに対応するメッセージ文字列を取得してください。

解説(Remarks)

GetIfTable 関数は、ローカル システム上の物理インターフェイスを列挙し、その情報を MIB_IFTABLE 構造体で返します。物理インターフェイスには、ソフトウェア ループバック インターフェイスが含まれます。

Windows Vista 以降で利用可能な GetIfTable2 関数および GetIfTable2Ex 関数は、GetIfTable 関数の機能拡張版であり、ローカル システム上の物理インターフェイスと論理インターフェイスの両方を列挙します。論理インターフェイスには、L2TP、PPTP、PPOE、その他のトンネル カプセル化に使用されるさまざまな WAN Miniport インターフェイスが含まれます。

インターフェイスは、pIfTable パラメーターが指すバッファー内の MIB_IFTABLE 構造体で返されます。MIB_IFTABLE 構造体には、インターフェイス数と、各インターフェイスに対応する MIB_IFROW 構造体の配列が含まれます。

pIfTable パラメーターが指す、返された MIB_IFTABLE 構造体には、dwNumEntries メンバーと、MIB_IFTABLE 構造体の table メンバー内の最初の MIB_IFROW 配列要素との間に、アラインメントのためのパディングが含まれている場合があることに注意してください。アラインメントのためのパディングは、MIB_IFROW 配列要素間にも存在する場合があります。MIB_IFROW 配列要素にアクセスする際は、常にパディングが存在する可能性を想定してください。

次の例では、インターフェイス テーブルを取得し、テーブル内のエントリ数と各エントリの一部のデータを出力します。

#include <winsock2.h>
#include <ws2tcpip.h>
#pragma comment(lib, "IPHLPAPI.lib")

#include <iphlpapi.h>

#include <stdio.h>
#include <stdlib.h>

#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.

    DWORD dwSize = 0;
    DWORD dwRetVal = 0;

    unsigned int i, j;

    /* variables used for GetIfTable and GetIfEntry */
    MIB_IFTABLE *pIfTable;
    MIB_IFROW *pIfRow;

    // Allocate memory for our pointers.
    pIfTable = (MIB_IFTABLE *) MALLOC(sizeof (MIB_IFTABLE));
    if (pIfTable == NULL) {
        printf("Error allocating memory needed to call GetIfTable\n");
        return 1;
    }
    // Make an initial call to GetIfTable to get the
    // necessary size into dwSize
    dwSize = sizeof (MIB_IFTABLE);
    if (GetIfTable(pIfTable, &dwSize, FALSE) == ERROR_INSUFFICIENT_BUFFER) {
        FREE(pIfTable);
        pIfTable = (MIB_IFTABLE *) MALLOC(dwSize);
        if (pIfTable == NULL) {
            printf("Error allocating memory needed to call GetIfTable\n");
            return 1;
        }
    }
    // Make a second call to GetIfTable to get the actual
    // data we want.
    if ((dwRetVal = GetIfTable(pIfTable, &dwSize, FALSE)) == NO_ERROR) {
        printf("\tNum Entries: %ld\n\n", pIfTable->dwNumEntries);
        for (i = 0; i < pIfTable->dwNumEntries; i++) {
            pIfRow = (MIB_IFROW *) & pIfTable->table[i];
            printf("\tIndex[%d]:\t %ld\n", i, pIfRow->dwIndex);
            printf("\tInterfaceName[%d]:\t %ws", i, pIfRow->wszName);
            printf("\n");
            printf("\tDescription[%d]:\t ", i);
            for (j = 0; j < pIfRow->dwDescrLen; j++)
                printf("%c", pIfRow->bDescr[j]);
            printf("\n");
            printf("\tType[%d]:\t ", i);
            switch (pIfRow->dwType) {
            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 Lookback\n");
                break;
            case IF_TYPE_ATM:
                printf("ATM\n");
                break;
            case IF_TYPE_IEEE80211:
                printf("IEEE 802.11 Wireless\n");
                break;
            case IF_TYPE_TUNNEL:
                printf("Tunnel type encapsulation\n");
                break;
            case IF_TYPE_IEEE1394:
                printf("IEEE 1394 Firewire\n");
                break;
            default:
                printf("Unknown type %ld\n", pIfRow->dwType);
                break;
            }
            printf("\tMtu[%d]:\t\t %ld\n", i, pIfRow->dwMtu);
            printf("\tSpeed[%d]:\t %ld\n", i, pIfRow->dwSpeed);
            printf("\tPhysical Addr:\t ");
            if (pIfRow->dwPhysAddrLen == 0)
                printf("\n");
            for (j = 0; j < pIfRow->dwPhysAddrLen; j++) {
                if (j == (pIfRow->dwPhysAddrLen - 1))
                    printf("%.2X\n", (int) pIfRow->bPhysAddr[j]);
                else
                    printf("%.2X-", (int) pIfRow->bPhysAddr[j]);
            }
            printf("\tAdmin Status[%d]:\t %ld\n", i, pIfRow->dwAdminStatus);
            printf("\tOper Status[%d]:\t ", i);
            switch (pIfRow->dwOperStatus) {
            case IF_OPER_STATUS_NON_OPERATIONAL:
                printf("Non Operational\n");
                break;
            case IF_OPER_STATUS_UNREACHABLE:
                printf("Unreachable\n");
                break;
            case IF_OPER_STATUS_DISCONNECTED:
                printf("Disconnected\n");
                break;
            case IF_OPER_STATUS_CONNECTING:
                printf("Connecting\n");
                break;
            case IF_OPER_STATUS_CONNECTED:
                printf("Connected\n");
                break;
            case IF_OPER_STATUS_OPERATIONAL:
                printf("Operational\n");
                break;
            default:
                printf("Unknown status %ld\n", pIfRow->dwAdminStatus);
                break;
            }
            printf("\n");
        }
    } else {
        printf("GetIfTable failed with error: \n", dwRetVal);
        if (pIfTable != NULL) {
            FREE(pIfTable);
            pIfTable = NULL;
        }  
        return 1;
        // Here you can use FormatMessage to find out why 
        // it failed.
    }
    if (pIfTable != NULL) {
        FREE(pIfTable);
        pIfTable = 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 GetIfTable(
    MIB_IFTABLE* pIfTable,   // optional
    DWORD* pdwSize,
    BOOL bOrder
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIfTable(
    IntPtr pIfTable,   // MIB_IFTABLE* optional, out
    ref uint pdwSize,   // DWORD* in/out
    bool bOrder   // BOOL
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIfTable(
    pIfTable As IntPtr,   ' MIB_IFTABLE* optional, out
    ByRef pdwSize As UInteger,   ' DWORD* in/out
    bOrder As Boolean   ' BOOL
) As UInteger
End Function
' pIfTable : MIB_IFTABLE* optional, out
' pdwSize : DWORD* in/out
' bOrder : BOOL
Declare PtrSafe Function GetIfTable Lib "iphlpapi" ( _
    ByVal pIfTable As LongPtr, _
    ByRef pdwSize As Long, _
    ByVal bOrder As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetIfTable = ctypes.windll.iphlpapi.GetIfTable
GetIfTable.restype = wintypes.DWORD
GetIfTable.argtypes = [
    ctypes.c_void_p,  # pIfTable : MIB_IFTABLE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwSize : DWORD* in/out
    wintypes.BOOL,  # bOrder : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIfTable = iphlpapi.NewProc("GetIfTable")
)

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

extern "iphlpapi" fn GetIfTable(
    pIfTable: [*c]MIB_IFTABLE, // MIB_IFTABLE* optional, out
    pdwSize: [*c]u32, // DWORD* in/out
    bOrder: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
proc GetIfTable(
    pIfTable: ptr MIB_IFTABLE,  # MIB_IFTABLE* optional, out
    pdwSize: ptr uint32,  # DWORD* in/out
    bOrder: int32  # BOOL
): uint32 {.importc: "GetIfTable", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetIfTable(
    MIB_IFTABLE* pIfTable,   // MIB_IFTABLE* optional, out
    uint* pdwSize,   // DWORD* in/out
    int bOrder   // BOOL
);
ccall((:GetIfTable, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{MIB_IFTABLE}, Ptr{UInt32}, Int32),
      pIfTable, pdwSize, bOrder)
# pIfTable : MIB_IFTABLE* optional, out -> Ptr{MIB_IFTABLE}
# pdwSize : DWORD* in/out -> Ptr{UInt32}
# bOrder : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetIfTable(
    void* pIfTable,
    uint32_t* pdwSize,
    int32_t bOrder);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetIfTable(pIfTable, pdwSize, bOrder)
-- pIfTable : MIB_IFTABLE* optional, out
-- pdwSize : DWORD* in/out
-- bOrder : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetIfTable = lib.func('__stdcall', 'GetIfTable', 'uint32_t', ['void *', 'uint32_t *', 'int32_t']);
// GetIfTable(pIfTable, pdwSize, bOrder)
// pIfTable : MIB_IFTABLE* optional, out -> 'void *'
// pdwSize : DWORD* in/out -> 'uint32_t *'
// bOrder : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetIfTable: { parameters: ["pointer", "pointer", "i32"], result: "u32" },
});
// lib.symbols.GetIfTable(pIfTable, pdwSize, bOrder)
// pIfTable : MIB_IFTABLE* optional, out -> "pointer"
// pdwSize : DWORD* in/out -> "pointer"
// bOrder : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetIfTable(
    void* pIfTable,
    uint32_t* pdwSize,
    int32_t bOrder);
C, "IPHLPAPI.dll");
// $ffi->GetIfTable(pIfTable, pdwSize, bOrder);
// pIfTable : MIB_IFTABLE* optional, out
// pdwSize : DWORD* in/out
// bOrder : 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 GetIfTable(
        Pointer pIfTable,   // MIB_IFTABLE* optional, out
        IntByReference pdwSize,   // DWORD* in/out
        boolean bOrder   // BOOL
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetIfTable = GetIfTable(
    pIfTable : MIB_IFTABLE*,   # MIB_IFTABLE* optional, out
    pdwSize : UInt32*,   # DWORD* in/out
    bOrder : 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 GetIfTableNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Int32);
typedef GetIfTableDart = int Function(Pointer<Void>, Pointer<Uint32>, int);
final GetIfTable = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetIfTableNative, GetIfTableDart>('GetIfTable');
// pIfTable : MIB_IFTABLE* optional, out -> Pointer<Void>
// pdwSize : DWORD* in/out -> Pointer<Uint32>
// bOrder : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetIfTable(
  pIfTable: Pointer;   // MIB_IFTABLE* optional, out
  pdwSize: Pointer;   // DWORD* in/out
  bOrder: BOOL   // BOOL
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIfTable';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getiftable =
  foreign "GetIfTable"
    ((ptr void) @-> (ptr uint32_t) @-> int32_t @-> returning uint32_t)
(* pIfTable : MIB_IFTABLE* optional, out -> (ptr void) *)
(* pdwSize : DWORD* in/out -> (ptr uint32_t) *)
(* bOrder : 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 ("GetIfTable" get-if-table :convention :stdcall) :uint32
  (p-if-table :pointer)   ; MIB_IFTABLE* optional, out
  (pdw-size :pointer)   ; DWORD* in/out
  (b-order :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetIfTable = Win32::API::More->new('IPHLPAPI',
    'DWORD GetIfTable(LPVOID pIfTable, LPVOID pdwSize, BOOL bOrder)');
# my $ret = $GetIfTable->Call($pIfTable, $pdwSize, $bOrder);
# pIfTable : MIB_IFTABLE* optional, out -> LPVOID
# pdwSize : DWORD* in/out -> LPVOID
# bOrder : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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