ホーム › NetworkManagement.IpHelper › GetIfTable2

GetIfTable2

関数

全ネットワークインターフェイスの詳細情報テーブルを取得する。

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

シグネチャ

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

WIN32_ERROR GetIfTable2(
    MIB_IF_TABLE2** Table
);

パラメーター

名前	型	方向	説明
Table	MIB_IF_TABLE2**	out	MIB_IF_TABLE2 構造体形式のインターフェイステーブルを受け取るバッファーへのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

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

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

戻りコード	説明
ERROR_NOT_ENOUGH_MEMORY	操作を完了するのに十分なメモリリソースがありません。
Other	返されたエラーに対応するメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

GetIfTable2 関数は、ローカルシステム上の論理インターフェイスおよび物理インターフェイスを列挙し、その情報を MIB_IF_TABLE2 構造体で返します。GetIfTable2 は GetIfTable 関数の拡張版です。

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

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

Table パラメーターが指す、返された MIB_IF_TABLE2 構造体では、MIB_IF_TABLE2 構造体の NumEntries メンバーと 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 GetIfTable2(
    MIB_IF_TABLE2** Table
);

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

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

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

import ctypes
from ctypes import wintypes

GetIfTable2 = ctypes.windll.iphlpapi.GetIfTable2
GetIfTable2.restype = wintypes.DWORD
GetIfTable2.argtypes = [
    ctypes.c_void_p,  # Table : MIB_IF_TABLE2** out
]

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "iphlpapi")]
extern "system" {
    fn GetIfTable2(
        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 GetIfTable2(IntPtr Table);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetIfTable2' -Namespace Win32 -PassThru
# $api::GetIfTable2(Table)

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

出力引数:

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