ホーム › NetworkManagement.IpHelper › GetBestRoute2

GetBestRoute2

関数

指定送信元・宛先アドレスに最適な経路と送信元を取得する。

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

シグネチャ

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

WIN32_ERROR GetBestRoute2(
    NET_LUID_LH* InterfaceLuid,   // optional
    DWORD InterfaceIndex,
    const SOCKADDR_INET* SourceAddress,   // optional
    const SOCKADDR_INET* DestinationAddress,
    DWORD AddressSortOptions,
    MIB_IPFORWARD_ROW2* BestRoute,
    SOCKADDR_INET* BestSourceAddress
);

パラメーター

名前	型	方向	説明
InterfaceLuid	NET_LUID_LH*	inoptional	IP ルートエントリに関連付けられたネットワークインターフェイスを指定するためのローカル一意識別子 (LUID)。
InterfaceIndex	DWORD	in	IP ルートエントリに関連付けられたネットワークインターフェイスを指定するためのローカルインデックス値。このインデックス値は、ネットワークアダプターが無効化された後に再び有効化された場合やその他の状況で変化することがあるため、永続的なものと見なすべきではありません。
SourceAddress	SOCKADDR_INET*	inoptional	ソース IP アドレス。このパラメーターは省略可能で、NULL ポインターとして渡すことができます。
DestinationAddress	SOCKADDR_INET*	in	宛先 IP アドレス。
AddressSortOptions	DWORD	in	IP アドレスのソート方法に影響を与えるオプションのセット。このパラメーターは現在使用されていません。
BestRoute	MIB_IPFORWARD_ROW2*	out	ソース IP アドレスから宛先 IP アドレスへの最適なルートを表す MIB_IPFORWARD_ROW2 へのポインター。
BestSourceAddress	SOCKADDR_INET*	out	最適なソース IP アドレスへのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定された宛先 IP アドレスへの最適なルートに対応する IP ルートエントリを、ローカルコンピューター上から取得します。

戻り値

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

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

戻り値	説明
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、DestinationAddress、BestSourceAddress、または BestRoute パラメーターに NULL ポインターが渡された場合に返されます。また、DestinationAddress パラメーターが IPv4 または IPv6 のアドレスとファミリを指定していない場合にも返されます。
ERROR_FILE_NOT_FOUND	指定されたインターフェイスが見つかりませんでした。このエラーは、InterfaceLuid または InterfaceIndex パラメーターで指定されたネットワークインターフェイスが見つからなかった場合に返されます。
ERROR_NOT_SUPPORTED	要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在しないにもかかわらず、DestinationAddress パラメーターで IPv4 のアドレスとファミリが指定された場合に返されます。また、ローカルコンピューターに IPv6 スタックが存在しないにもかかわらず、DestinationAddress パラメーターで IPv6 のアドレスとファミリが指定された場合にも返されます。
その他	返されたエラーに対応するメッセージ文字列を取得するには、FormatMessage を使用してください。

解説(Remarks)

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

GetBestRoute2 関数は、ソース IP アドレスから宛先 IP アドレスへの最適なルートを表す MIB_IPFORWARD_ROW2 構造体のエントリを取得するために使用します。

入力時、DestinationAddress パラメーターは有効な IPv4 または IPv6 のアドレスとファミリに初期化されている必要があります。入力時、SourceAddress パラメーターは優先する IPv4 または IPv6 のアドレスとファミリに初期化できます。さらに、InterfaceLuid または InterfaceIndex の少なくとも一方が初期化されている必要があります。

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

呼び出しが成功した場合、出力時に GetBestRoute2 は、ソース IP アドレスから宛先 IP アドレスへの最適なルートを表す 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 GetBestRoute2(
    NET_LUID_LH* InterfaceLuid,   // optional
    DWORD InterfaceIndex,
    const SOCKADDR_INET* SourceAddress,   // optional
    const SOCKADDR_INET* DestinationAddress,
    DWORD AddressSortOptions,
    MIB_IPFORWARD_ROW2* BestRoute,
    SOCKADDR_INET* BestSourceAddress
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetBestRoute2(
    IntPtr InterfaceLuid,   // NET_LUID_LH* optional
    uint InterfaceIndex,   // DWORD
    IntPtr SourceAddress,   // SOCKADDR_INET* optional
    IntPtr DestinationAddress,   // SOCKADDR_INET*
    uint AddressSortOptions,   // DWORD
    IntPtr BestRoute,   // MIB_IPFORWARD_ROW2* out
    IntPtr BestSourceAddress   // SOCKADDR_INET* out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetBestRoute2(
    InterfaceLuid As IntPtr,   ' NET_LUID_LH* optional
    InterfaceIndex As UInteger,   ' DWORD
    SourceAddress As IntPtr,   ' SOCKADDR_INET* optional
    DestinationAddress As IntPtr,   ' SOCKADDR_INET*
    AddressSortOptions As UInteger,   ' DWORD
    BestRoute As IntPtr,   ' MIB_IPFORWARD_ROW2* out
    BestSourceAddress As IntPtr   ' SOCKADDR_INET* out
) As UInteger
End Function

' InterfaceLuid : NET_LUID_LH* optional
' InterfaceIndex : DWORD
' SourceAddress : SOCKADDR_INET* optional
' DestinationAddress : SOCKADDR_INET*
' AddressSortOptions : DWORD
' BestRoute : MIB_IPFORWARD_ROW2* out
' BestSourceAddress : SOCKADDR_INET* out
Declare PtrSafe Function GetBestRoute2 Lib "iphlpapi" ( _
    ByVal InterfaceLuid As LongPtr, _
    ByVal InterfaceIndex As Long, _
    ByVal SourceAddress As LongPtr, _
    ByVal DestinationAddress As LongPtr, _
    ByVal AddressSortOptions As Long, _
    ByVal BestRoute As LongPtr, _
    ByVal BestSourceAddress As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetBestRoute2 = ctypes.windll.iphlpapi.GetBestRoute2
GetBestRoute2.restype = wintypes.DWORD
GetBestRoute2.argtypes = [
    ctypes.c_void_p,  # InterfaceLuid : NET_LUID_LH* optional
    wintypes.DWORD,  # InterfaceIndex : DWORD
    ctypes.c_void_p,  # SourceAddress : SOCKADDR_INET* optional
    ctypes.c_void_p,  # DestinationAddress : SOCKADDR_INET*
    wintypes.DWORD,  # AddressSortOptions : DWORD
    ctypes.c_void_p,  # BestRoute : MIB_IPFORWARD_ROW2* out
    ctypes.c_void_p,  # BestSourceAddress : SOCKADDR_INET* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetBestRoute2 = Fiddle::Function.new(
  lib['GetBestRoute2'],
  [
    Fiddle::TYPE_VOIDP,  # InterfaceLuid : NET_LUID_LH* optional
    -Fiddle::TYPE_INT,  # InterfaceIndex : DWORD
    Fiddle::TYPE_VOIDP,  # SourceAddress : SOCKADDR_INET* optional
    Fiddle::TYPE_VOIDP,  # DestinationAddress : SOCKADDR_INET*
    -Fiddle::TYPE_INT,  # AddressSortOptions : DWORD
    Fiddle::TYPE_VOIDP,  # BestRoute : MIB_IPFORWARD_ROW2* out
    Fiddle::TYPE_VOIDP,  # BestSourceAddress : SOCKADDR_INET* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetBestRoute2(
        InterfaceLuid: *mut NET_LUID_LH,  // NET_LUID_LH* optional
        InterfaceIndex: u32,  // DWORD
        SourceAddress: *const SOCKADDR_INET,  // SOCKADDR_INET* optional
        DestinationAddress: *const SOCKADDR_INET,  // SOCKADDR_INET*
        AddressSortOptions: u32,  // DWORD
        BestRoute: *mut MIB_IPFORWARD_ROW2,  // MIB_IPFORWARD_ROW2* out
        BestSourceAddress: *mut SOCKADDR_INET  // SOCKADDR_INET* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetBestRoute2(IntPtr InterfaceLuid, uint InterfaceIndex, IntPtr SourceAddress, IntPtr DestinationAddress, uint AddressSortOptions, IntPtr BestRoute, IntPtr BestSourceAddress);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetBestRoute2' -Namespace Win32 -PassThru
# $api::GetBestRoute2(InterfaceLuid, InterfaceIndex, SourceAddress, DestinationAddress, AddressSortOptions, BestRoute, BestSourceAddress)

#uselib "IPHLPAPI.dll"
#func global GetBestRoute2 "GetBestRoute2" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; GetBestRoute2 varptr(InterfaceLuid), InterfaceIndex, varptr(SourceAddress), varptr(DestinationAddress), AddressSortOptions, varptr(BestRoute), varptr(BestSourceAddress)   ; 戻り値は stat
; InterfaceLuid : NET_LUID_LH* optional -> "sptr"
; InterfaceIndex : DWORD -> "sptr"
; SourceAddress : SOCKADDR_INET* optional -> "sptr"
; DestinationAddress : SOCKADDR_INET* -> "sptr"
; AddressSortOptions : DWORD -> "sptr"
; BestRoute : MIB_IPFORWARD_ROW2* out -> "sptr"
; BestSourceAddress : SOCKADDR_INET* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global GetBestRoute2 "GetBestRoute2" var, int, var, var, int, var, var
; res = GetBestRoute2(InterfaceLuid, InterfaceIndex, SourceAddress, DestinationAddress, AddressSortOptions, BestRoute, BestSourceAddress)
; InterfaceLuid : NET_LUID_LH* optional -> "var"
; InterfaceIndex : DWORD -> "int"
; SourceAddress : SOCKADDR_INET* optional -> "var"
; DestinationAddress : SOCKADDR_INET* -> "var"
; AddressSortOptions : DWORD -> "int"
; BestRoute : MIB_IPFORWARD_ROW2* out -> "var"
; BestSourceAddress : SOCKADDR_INET* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global GetBestRoute2 "GetBestRoute2" sptr, int, sptr, sptr, int, sptr, sptr
; res = GetBestRoute2(varptr(InterfaceLuid), InterfaceIndex, varptr(SourceAddress), varptr(DestinationAddress), AddressSortOptions, varptr(BestRoute), varptr(BestSourceAddress))
; InterfaceLuid : NET_LUID_LH* optional -> "sptr"
; InterfaceIndex : DWORD -> "int"
; SourceAddress : SOCKADDR_INET* optional -> "sptr"
; DestinationAddress : SOCKADDR_INET* -> "sptr"
; AddressSortOptions : DWORD -> "int"
; BestRoute : MIB_IPFORWARD_ROW2* out -> "sptr"
; BestSourceAddress : SOCKADDR_INET* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。