GetBestRoute2

ローカルコンピュータ上で、指定した宛先 IP アドレスへの最適経路の IP 経路エントリを取得する。

GetBestRoute2 InterfaceLuid, InterfaceIndex, SourceAddress, DestinationAddress, AddressSortOptions, BestRoute, BestSourceAddress

InterfaceLuid : [var] IP 経路エントリに関連付けるネットワークインターフェイスのローカル一意識別子 (LUID)。
InterfaceIndex : [int] IP 経路エントリに関連付けるネットワークインターフェイスのローカルインデックス値。無効化・再有効化時などに変わることがあるため永続値として扱ってはならない。
SourceAddress : [var] 送信元 IP アドレス。省略して NULL を渡してもよい。
DestinationAddress : [var] 宛先 IP アドレス。
AddressSortOptions : [int] IP アドレスのソート方法に影響するオプション一式。現在未使用。
BestRoute : [var] 送信元 IP アドレスから宛先 IP アドレスへの最適経路の MIB_IPFORWARD_ROW2 へのポインタ。
BestSourceAddress : [var] 最適な送信元 IP アドレスへのポインタ。

(プラグイン / モジュール : iphlpapi.dll)

解説

ローカルコンピュータ上で、指定した宛先 IP アドレスへの最適経路の IP 経路エントリを取得する。

[戻り値]
関数が成功すると戻り値は NO_ERROR となる。失敗した場合の戻り値は以下のいずれかのエラーコードとなる。
このドキュメントは省略されている。

[備考]
GetBestRoute2 関数は Windows Vista 以降で定義される。送信元 IP から宛先 IP への最適経路の
MIB_IPFORWARD_ROW2 を取得する。DestinationAddress は有効な IPv4 / IPv6
アドレスとファミリで初期化する。SourceAddress は希望するアドレスで初期化してもよい。InterfaceLuid または
InterfaceIndex のいずれかも初期化する必要がある (InterfaceLuid 優先)。成功時、最適経路の
MIB_IPFORWARD_ROW2 が返される。

情報

プラグイン / モジュールiphlpapi.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の iphlpapi.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_iphlpapi_gen2.hs