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

GetIpPathEntry

関数
指定したIPパス(経路)エントリの情報を取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR GetIpPathEntry(
    MIB_IPPATH_ROW* Row
);

パラメーター

名前型方向説明
RowMIB_IPPATH_ROW*inoutIP パスエントリ用の MIB_IPPATH_ROW 構造体エントリへのポインター。正常に返ると、この構造体は IP パスエントリのプロパティで更新されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

ローカルコンピューター上の IP パスエントリの情報を取得します。

戻り値

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

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

戻りコード 説明
ERROR_FILE_NOT_FOUND
 指定されたファイルが見つかりません。このエラーは、Row パラメーターが指す MIB_IPPATH_ROW の InterfaceLuid または InterfaceIndex メンバーで指定されたネットワークインターフェイス LUID またはインターフェイスインデックスが、ローカルマシン上の値でない場合に返されます。
ERROR_INVALID_PARAMETER
 パラメーターが正しくありません。このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指す MIB_IPPATH_ROW の Destination メンバー内の si_family メンバーが AF_INET または AF_INET6 に設定されていない場合、または Row パラメーターが指す MIB_IPPATH_ROW の InterfaceLuid および InterfaceIndex メンバーの両方が未指定の場合に返されます。また、Row パラメーターが指す MIB_IPPATH_ROW の Source メンバー内の si_family メンバーが宛先 IP アドレスファミリと一致せず、かつ送信元 IP アドレスの si_family が AF_UNSPEC として指定されていない場合にも返されます。
ERROR_NOT_FOUND
 要素が見つかりません。このエラーは、Row パラメーターが指す MIB_IPPATH_ROW 構造体の InterfaceLuid または InterfaceIndex メンバーで指定されたネットワークインターフェイスが、MIB_IPPATH_ROW 構造体の Destination メンバーで指定された IP アドレスおよびアドレスファミリと一致しない場合に返されます。
ERROR_NOT_SUPPORTED
 要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在せず、Row パラメーターが指す MIB_IPPATH_ROW の Source および Destination メンバーに IPv4 アドレスが指定されている場合に返されます。また、ローカルコンピューターに IPv6 スタックが存在せず、Source および Destination メンバーに IPv6 アドレスが指定されている場合にも返されます。
その他
 返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

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

GetIpPathEntry 関数は、MIB_IPPATH_ROW 構造体エントリを取得するために使用します。

入力時には、Row パラメーターが指す MIB_IPPATH_ROW 構造体の Destination メンバーを、有効な IPv4 または IPv6 アドレスおよびファミリで初期化しておく必要があります。MIB_IPPATH_ROW 構造体の Source メンバーで指定するアドレスファミリは、Destination メンバーで指定した宛先 IP アドレスファミリと一致するか、または Source メンバーのアドレスファミリを AF_UNSPEC として指定する必要があります。さらに、Row パラメーターが指す MIB_IPPATH_ROW 構造体の次のメンバーのうち、少なくとも 1 つを初期化しておく必要があります。InterfaceLuid または InterfaceIndex です。

これらのフィールドは上記の順序で使用されます。したがって、InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが決定されます。InterfaceLuid メンバーに値が設定されていない場合(このメンバーの値がゼロに設定されている場合)は、次に InterfaceIndex メンバーを使用してインターフェイスが決定されます。

出力時、呼び出しが成功すると、GetIpPathEntry は IP パスエントリのその他のプロパティを取得し、Row パラメーターが指す MIB_IPPATH_ROW 構造体に値を設定します。

ローカルコンピューター上の IP パスエントリを列挙するには、GetIpPathTable 関数を呼び出すことができます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetIpPathEntry(
    MIB_IPPATH_ROW* Row
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpPathEntry(
    IntPtr Row   // MIB_IPPATH_ROW* in/out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpPathEntry(
    Row As IntPtr   ' MIB_IPPATH_ROW* in/out
) As UInteger
End Function
' Row : MIB_IPPATH_ROW* in/out
Declare PtrSafe Function GetIpPathEntry Lib "iphlpapi" ( _
    ByVal Row As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetIpPathEntry = ctypes.windll.iphlpapi.GetIpPathEntry
GetIpPathEntry.restype = wintypes.DWORD
GetIpPathEntry.argtypes = [
    ctypes.c_void_p,  # Row : MIB_IPPATH_ROW* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIpPathEntry = iphlpapi.NewProc("GetIpPathEntry")
)

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

extern "iphlpapi" fn GetIpPathEntry(
    Row: [*c]MIB_IPPATH_ROW // MIB_IPPATH_ROW* in/out
) callconv(std.os.windows.WINAPI) u32;
proc GetIpPathEntry(
    Row: ptr MIB_IPPATH_ROW  # MIB_IPPATH_ROW* in/out
): uint32 {.importc: "GetIpPathEntry", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetIpPathEntry(
    MIB_IPPATH_ROW* Row   // MIB_IPPATH_ROW* in/out
);
ccall((:GetIpPathEntry, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{MIB_IPPATH_ROW},),
      Row)
# Row : MIB_IPPATH_ROW* in/out -> Ptr{MIB_IPPATH_ROW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetIpPathEntry(
    void* Row);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetIpPathEntry(Row)
-- Row : MIB_IPPATH_ROW* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetIpPathEntry = lib.func('__stdcall', 'GetIpPathEntry', 'uint32_t', ['void *']);
// GetIpPathEntry(Row)
// Row : MIB_IPPATH_ROW* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetIpPathEntry: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.GetIpPathEntry(Row)
// Row : MIB_IPPATH_ROW* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetIpPathEntry(
    void* Row);
C, "IPHLPAPI.dll");
// $ffi->GetIpPathEntry(Row);
// Row : MIB_IPPATH_ROW* in/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 GetIpPathEntry(
        Pointer Row   // MIB_IPPATH_ROW* in/out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetIpPathEntry = GetIpPathEntry(
    Row : MIB_IPPATH_ROW*   # MIB_IPPATH_ROW* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetIpPathEntryNative = Uint32 Function(Pointer<Void>);
typedef GetIpPathEntryDart = int Function(Pointer<Void>);
final GetIpPathEntry = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetIpPathEntryNative, GetIpPathEntryDart>('GetIpPathEntry');
// Row : MIB_IPPATH_ROW* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetIpPathEntry(
  Row: Pointer   // MIB_IPPATH_ROW* in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIpPathEntry';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetIpPathEntry"
  c_GetIpPathEntry :: Ptr () -> IO Word32
-- Row : MIB_IPPATH_ROW* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

関連項目

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