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

GetIpPathTable

関数
指定アドレスファミリのIPパス(経路)テーブルを取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR GetIpPathTable(
    ADDRESS_FAMILY Family,
    MIB_IPPATH_TABLE** Table
);

パラメーター

名前方向説明
FamilyADDRESS_FAMILYin

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

アドレスファミリに指定可能な値は Winsock2.h ヘッダーファイルに一覧があります。AF_ アドレスファミリ定数と PF_ プロトコルファミリ定数の値は同一である(例: AF_INETPF_INET)ため、どちらの定数を使用してもかまいません。

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

現在サポートされている値は AF_INETAF_INET6AF_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 パステーブルを返します。
TableMIB_IPPATH_TABLE**outローカルコンピューター上の IP パスエントリのテーブルを格納する MIB_IPPATH_TABLE 構造体へのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

GetIpPathTable 関数は、ローカルコンピューター上の 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
要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在せず、かつ Family パラメーターに AF_INET が指定された場合に返されます。また、ローカルコンピューターに IPv6 スタックが存在せず、かつ Family パラメーターに AF_INET6 が指定された場合にも返されます。さらに、この関数がサポートされていないバージョンの Windows でも返されます。
その他
返されたエラーに対応するメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

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

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

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

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetIpPathTable(
    ADDRESS_FAMILY Family,
    MIB_IPPATH_TABLE** Table
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpPathTable(
    ushort Family,   // ADDRESS_FAMILY
    IntPtr Table   // MIB_IPPATH_TABLE** out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpPathTable(
    Family As UShort,   ' ADDRESS_FAMILY
    Table As IntPtr   ' MIB_IPPATH_TABLE** out
) As UInteger
End Function
' Family : ADDRESS_FAMILY
' Table : MIB_IPPATH_TABLE** out
Declare PtrSafe Function GetIpPathTable 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

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

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIpPathTable = iphlpapi.NewProc("GetIpPathTable")
)

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

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

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

let getippathtable =
  foreign "GetIpPathTable"
    (uint16_t @-> (ptr void) @-> returning uint32_t)
(* Family : ADDRESS_FAMILY -> uint16_t *)
(* Table : MIB_IPPATH_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 ("GetIpPathTable" get-ip-path-table :convention :stdcall) :uint32
  (family :uint16)   ; ADDRESS_FAMILY
  (table :pointer))   ; MIB_IPPATH_TABLE** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetIpPathTable = Win32::API::More->new('IPHLPAPI',
    'DWORD GetIpPathTable(WORD Family, LPVOID Table)');
# my $ret = $GetIpPathTable->Call($Family, $Table);
# Family : ADDRESS_FAMILY -> WORD
# Table : MIB_IPPATH_TABLE** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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