ホーム › NetworkManagement.IpHelper › GetBestInterface

GetBestInterface

関数

指定IPv4宛先への送信に最適なインターフェイス索引を取得する。

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

シグネチャ

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

DWORD GetBestInterface(
    DWORD dwDestAddr,
    DWORD* pdwBestIfIndex
);

パラメーター

名前	型	方向	説明
dwDestAddr	DWORD	in	最適なルートを持つインターフェイスを取得する対象となる、宛先の IPv4 アドレス。IPAddr 構造体の形式で指定します。
pdwBestIfIndex	DWORD*	out	dwDestAddr で指定した IPv4 アドレスへの最適なルートを持つインターフェイスのインデックスを受け取る DWORD 変数へのポインター。

戻り値の型: DWORD

公式ドキュメント

GetBestInterface 関数は、指定した IPv4 アドレスへの最適なルートを持つインターフェイスのインデックスを取得します。

戻り値

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

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

戻りコード	説明
ERROR_CAN_NOT_COMPLETE	操作を完了できませんでした。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、pdwBestIfIndex パラメーターに NULL ポインターが渡された場合、または pdwBestIfIndex が書き込み不可能なメモリを指している場合に返されます。
ERROR_NOT_SUPPORTED	要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在しない場合に返されます。
その他	FormatMessage 関数を使用して、返されたエラーに対応するメッセージ文字列を取得してください。

解説(Remarks)

GetBestInterface 関数は IPv4 アドレスでのみ動作します。IPv6 アドレスで使用する場合は、GetBestInterfaceEx を使用する必要があります。

IPAddr データ型については、Windows データ型を参照してください。IP アドレスをドット区切り 10 進表記と IPAddr 形式の間で変換するには、inet_addr 関数および inet_ntoa 関数を使用します。

Windows Vista 以降では、pdwBestIfIndex パラメーターは IP Helper によって内部的に NET_IFINDEX データ型へのポインターとして扱われます。

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

各言語での呼び出し定義

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

DWORD GetBestInterface(
    DWORD dwDestAddr,
    DWORD* pdwBestIfIndex
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetBestInterface(
    uint dwDestAddr,   // DWORD
    out uint pdwBestIfIndex   // DWORD* out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetBestInterface(
    dwDestAddr As UInteger,   ' DWORD
    <Out> ByRef pdwBestIfIndex As UInteger   ' DWORD* out
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

GetBestInterface = ctypes.windll.iphlpapi.GetBestInterface
GetBestInterface.restype = wintypes.DWORD
GetBestInterface.argtypes = [
    wintypes.DWORD,  # dwDestAddr : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwBestIfIndex : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetBestInterface = Fiddle::Function.new(
  lib['GetBestInterface'],
  [
    -Fiddle::TYPE_INT,  # dwDestAddr : DWORD
    Fiddle::TYPE_VOIDP,  # pdwBestIfIndex : DWORD* out
  ],
  -Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetBestInterface(uint dwDestAddr, out uint pdwBestIfIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetBestInterface' -Namespace Win32 -PassThru
# $api::GetBestInterface(dwDestAddr, pdwBestIfIndex)

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

出力引数:

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