ホーム › NetworkManagement.IpHelper › GetIfTable2Ex

GetIfTable2Ex

関数

指定レベルで全インターフェイスの詳細情報テーブルを取得する。

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

シグネチャ

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

WIN32_ERROR GetIfTable2Ex(
    MIB_IF_TABLE_LEVEL Level,
    MIB_IF_TABLE2** Table
);

パラメーター

名前

型

方向

説明

Level

MIB_IF_TABLE_LEVEL

取得するインターフェイス情報のレベルです。このパラメーターには、Netioapi.h ヘッダーファイルで定義されている MIB_IF_TABLE_LEVEL 列挙型の値のいずれかを指定できます。

値	意味
MibIfTableNormal	このパラメーターを指定すると、Table パラメーターが指す MIB_IF_TABLE2 構造体内の MIB_IF_ROW2 構造体のメンバーに返される統計情報と状態の値は、フィルタースタックの最上位から返されます。
MibIfTableRaw	Table パラメーターが指す MIB_IF_TABLE2 構造体内の MIB_IF_ROW2 構造体のメンバーに返される統計情報と状態の値は、照会対象のインターフェイスから直接返されます。

Table

MIB_IF_TABLE2**

out

インターフェイスのテーブルを MIB_IF_TABLE2 構造体として受け取るバッファーへのポインターです。

戻り値の型: WIN32_ERROR

公式ドキュメント

MIB-II インターフェイステーブルを取得します。(GetIfTable2Ex)

戻り値

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

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

戻り値コード	説明
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、Level パラメーターに不正な値が渡された場合に返されます。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するために十分なメモリリソースがありません。
その他	返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

GetIfTable2Ex 関数は、ローカルシステム上の論理インターフェイスと物理インターフェイスを列挙し、その情報を MIB_IF_TABLE2 構造体で返します。GetIfTable2Ex は GetIfTable 関数の拡張版であり、取得するインターフェイス情報のレベルを選択できます。

同様の GetIfTable2 関数もインターフェイスの取得に使用できますが、返すインターフェイスのレベルを指定することはできません。Level パラメーターを MibIfTableNormal に設定して GetIfTable2Ex 関数を呼び出すと、GetIfTable2 関数を呼び出した場合と同じ結果が取得されます。

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

NDIS 中間ドライバーインターフェイスや NDIS フィルタードライバーインターフェイスを含むすべてのインターフェイスは、Level パラメーターに指定可能ないずれの値に対しても返されます。Level パラメーターの設定は、Table パラメーターが指す MIB_IF_TABLE2 構造体内の、当該インターフェイスに対応する MIB_IF_ROW2 構造体の統計情報メンバーと状態メンバーがどのように返されるかに影響します。たとえば、ネットワークインターフェイスカード (NIC) には NDIS ミニポートドライバーが存在します。NDIS 中間ドライバーをインストールすると、上位レベルのプロトコルドライバーと NDIS ミニポートドライバーの間を仲介できます。さらに、NDIS フィルタードライバー (LWF) を NDIS 中間ドライバーの上に接続できます。ここで、NIC が MIB_IF_ROW2 構造体の MediaConnectState メンバーを MediaConnectStateConnected として報告するものの、NDIS フィルタードライバーがその状態を変更して MediaConnectStateDisconnected として報告すると仮定します。 Level パラメーターを MibIfTableNormal に設定してインターフェイス情報を照会すると、フィルタースタックの最上位の状態、すなわち MediaConnectStateDisconnected が報告されます。Level パラメーターを MibIfTableRaw に設定して照会すると、インターフェイスレベルの状態が直接返され、すなわち MediaConnectStateConnected が返されます。

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetIfTable2Ex(
    MIB_IF_TABLE_LEVEL Level,
    MIB_IF_TABLE2** Table
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIfTable2Ex(
    int Level,   // MIB_IF_TABLE_LEVEL
    IntPtr Table   // MIB_IF_TABLE2** out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIfTable2Ex(
    Level As Integer,   ' MIB_IF_TABLE_LEVEL
    Table As IntPtr   ' MIB_IF_TABLE2** out
) As UInteger
End Function

' Level : MIB_IF_TABLE_LEVEL
' Table : MIB_IF_TABLE2** out
Declare PtrSafe Function GetIfTable2Ex Lib "iphlpapi" ( _
    ByVal Level As Long, _
    ByVal Table As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetIfTable2Ex = ctypes.windll.iphlpapi.GetIfTable2Ex
GetIfTable2Ex.restype = wintypes.DWORD
GetIfTable2Ex.argtypes = [
    ctypes.c_int,  # Level : MIB_IF_TABLE_LEVEL
    ctypes.c_void_p,  # Table : MIB_IF_TABLE2** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetIfTable2Ex = Fiddle::Function.new(
  lib['GetIfTable2Ex'],
  [
    Fiddle::TYPE_INT,  # Level : MIB_IF_TABLE_LEVEL
    Fiddle::TYPE_VOIDP,  # Table : MIB_IF_TABLE2** out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetIfTable2Ex(
        Level: i32,  // MIB_IF_TABLE_LEVEL
        Table: *mut *mut MIB_IF_TABLE2  // MIB_IF_TABLE2** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetIfTable2Ex(int Level, IntPtr Table);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetIfTable2Ex' -Namespace Win32 -PassThru
# $api::GetIfTable2Ex(Level, Table)

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

出力引数:

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