ホーム › NetworkManagement.IpHelper › GetIpForwardTable2

GetIpForwardTable2

関数

指定アドレスファミリのIPルーティングテーブルを取得する。

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

シグネチャ

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

WIN32_ERROR GetIpForwardTable2(
    ADDRESS_FAMILY Family,
    MIB_IPFORWARD_TABLE2** Table
);

パラメーター

名前

型

方向

説明

Family

ADDRESS_FAMILY

取得するアドレスファミリ。

アドレスファミリに指定可能な値は、Winsock2.h ヘッダーファイルに記載されています。AF_ アドレスファミリ定数と PF_ プロトコルファミリ定数の値は同一である(たとえば AF_INET と PF_INET)ため、いずれの定数も使用できます。

Windows Vista 以降向けにリリースされた Windows SDK では、ヘッダーファイルの構成が変更され、このメンバーに指定可能な値は Ws2def.h ヘッダーファイルで定義されています。Ws2def.h ヘッダーファイルは Winsock2.h に自動的にインクルードされるため、直接使用しないでください。

現在サポートされている値は AF_INET、AF_INET6、AF_UNSPEC です。

値	意味
AF_UNSPEC 0	アドレスファミリが指定されていません。このパラメーターを指定すると、この関数は IPv4 と IPv6 の両方のエントリを含む IP ルーティングテーブルを返します。
AF_INET 2	Internet Protocol version 4 (IPv4) アドレスファミリ。このパラメーターを指定すると、この関数は IPv4 エントリのみを含む IP ルーティングテーブルを返します。
AF_INET6 23	Internet Protocol version 6 (IPv6) アドレスファミリ。このパラメーターを指定すると、この関数は IPv6 エントリのみを含む IP ルーティングテーブルを返します。

Table

MIB_IPFORWARD_TABLE2**

out

ローカルコンピューター上の IP ルートエントリのテーブルを格納する MIB_IPFORWARD_TABLE2 構造体へのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

GetIpForwardTable2 関数は、ローカルコンピューター上の IP ルートエントリを取得します。

戻り値

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

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

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

解説(Remarks)

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

GetIpForwardTable2 関数は、ローカルシステム上の IP ルートエントリを列挙し、その情報を MIB_IPFORWARD_TABLE2 構造体で返します。

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

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

Table パラメーターが指す、返される MIB_IPFORWARD_TABLE2 構造体には、MIB_IPFORWARD_TABLE2 構造体の NumEntries メンバーと Table メンバー内の最初の MIB_IPFORWARD_ROW2 配列エントリとの間に、アラインメントのためのパディングが含まれる場合があることに注意してください。また、MIB_IPFORWARD_ROW2 配列エントリ間にもアラインメントのためのパディングが存在する場合があります。MIB_IPFORWARD_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 GetIpForwardTable2(
    ADDRESS_FAMILY Family,
    MIB_IPFORWARD_TABLE2** Table
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpForwardTable2(
    ushort Family,   // ADDRESS_FAMILY
    IntPtr Table   // MIB_IPFORWARD_TABLE2** out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpForwardTable2(
    Family As UShort,   ' ADDRESS_FAMILY
    Table As IntPtr   ' MIB_IPFORWARD_TABLE2** out
) As UInteger
End Function

' Family : ADDRESS_FAMILY
' Table : MIB_IPFORWARD_TABLE2** out
Declare PtrSafe Function GetIpForwardTable2 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

GetIpForwardTable2 = ctypes.windll.iphlpapi.GetIpForwardTable2
GetIpForwardTable2.restype = wintypes.DWORD
GetIpForwardTable2.argtypes = [
    ctypes.c_ushort,  # Family : ADDRESS_FAMILY
    ctypes.c_void_p,  # Table : MIB_IPFORWARD_TABLE2** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetIpForwardTable2 = Fiddle::Function.new(
  lib['GetIpForwardTable2'],
  [
    -Fiddle::TYPE_SHORT,  # Family : ADDRESS_FAMILY
    Fiddle::TYPE_VOIDP,  # Table : MIB_IPFORWARD_TABLE2** out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetIpForwardTable2(
        Family: u16,  // ADDRESS_FAMILY
        Table: *mut *mut MIB_IPFORWARD_TABLE2  // MIB_IPFORWARD_TABLE2** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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