ホーム › NetworkManagement.IpHelper › GetBestRoute

GetBestRoute

関数

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

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

シグネチャ

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

DWORD GetBestRoute(
    DWORD dwDestAddr,
    DWORD dwSourceAddr,   // optional
    MIB_IPFORWARDROW* pBestRoute
);

パラメーター

名前	型	方向	説明
dwDestAddr	DWORD	in	最適なルートを取得する対象の宛先 IP アドレス。
dwSourceAddr	DWORD	inoptional	送信元 IP アドレス。この IP アドレスは、ローカルコンピューター上のインターフェイスに対応します。宛先アドレスへの最適なルートが複数存在する場合、関数はこのインターフェイスを使用するルートを選択します。このパラメーターは省略可能です。呼び出し元はこのパラメーターに 0 を指定できます。
pBestRoute	MIB_IPFORWARDROW*	out	dwDestAddr で指定された IP アドレスへの最適なルートを格納する MIB_IPFORWARDROW 構造体へのポインター。

名前

型

方向

説明

dwDestAddr

DWORD

最適なルートを取得する対象の宛先 IP アドレス。

dwSourceAddr

DWORD

inoptional

送信元 IP アドレス。この IP アドレスは、ローカルコンピューター上のインターフェイスに対応します。宛先アドレスへの最適なルートが複数存在する場合、関数はこのインターフェイスを使用するルートを選択します。

このパラメーターは省略可能です。呼び出し元はこのパラメーターに 0 を指定できます。

pBestRoute

MIB_IPFORWARDROW*

out

dwDestAddr で指定された IP アドレスへの最適なルートを格納する MIB_IPFORWARDROW 構造体へのポインター。

戻り値の型: DWORD

公式ドキュメント

GetBestRoute 関数は、指定された宛先 IP アドレスへの最適なルートを取得します。

戻り値

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

関数が失敗した場合は、 FormatMessage を使用して、返されたエラーに対応するメッセージ文字列を取得してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD GetBestRoute(
    DWORD dwDestAddr,
    DWORD dwSourceAddr,   // optional
    MIB_IPFORWARDROW* pBestRoute
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetBestRoute(
    uint dwDestAddr,   // DWORD
    uint dwSourceAddr,   // DWORD optional
    IntPtr pBestRoute   // MIB_IPFORWARDROW* out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetBestRoute(
    dwDestAddr As UInteger,   ' DWORD
    dwSourceAddr As UInteger,   ' DWORD optional
    pBestRoute As IntPtr   ' MIB_IPFORWARDROW* out
) As UInteger
End Function

' dwDestAddr : DWORD
' dwSourceAddr : DWORD optional
' pBestRoute : MIB_IPFORWARDROW* out
Declare PtrSafe Function GetBestRoute Lib "iphlpapi" ( _
    ByVal dwDestAddr As Long, _
    ByVal dwSourceAddr As Long, _
    ByVal pBestRoute As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetBestRoute = ctypes.windll.iphlpapi.GetBestRoute
GetBestRoute.restype = wintypes.DWORD
GetBestRoute.argtypes = [
    wintypes.DWORD,  # dwDestAddr : DWORD
    wintypes.DWORD,  # dwSourceAddr : DWORD optional
    ctypes.c_void_p,  # pBestRoute : MIB_IPFORWARDROW* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetBestRoute = Fiddle::Function.new(
  lib['GetBestRoute'],
  [
    -Fiddle::TYPE_INT,  # dwDestAddr : DWORD
    -Fiddle::TYPE_INT,  # dwSourceAddr : DWORD optional
    Fiddle::TYPE_VOIDP,  # pBestRoute : MIB_IPFORWARDROW* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetBestRoute(
        dwDestAddr: u32,  // DWORD
        dwSourceAddr: u32,  // DWORD optional
        pBestRoute: *mut MIB_IPFORWARDROW  // MIB_IPFORWARDROW* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetBestRoute(uint dwDestAddr, uint dwSourceAddr, IntPtr pBestRoute);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetBestRoute' -Namespace Win32 -PassThru
# $api::GetBestRoute(dwDestAddr, dwSourceAddr, pBestRoute)

#uselib "IPHLPAPI.dll"
#func global GetBestRoute "GetBestRoute" sptr, sptr, sptr
; GetBestRoute dwDestAddr, dwSourceAddr, varptr(pBestRoute)   ; 戻り値は stat
; dwDestAddr : DWORD -> "sptr"
; dwSourceAddr : DWORD optional -> "sptr"
; pBestRoute : MIB_IPFORWARDROW* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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