ホーム › NetworkManagement.IpHelper › GetIpNetworkConnectionBandwidthEstimates

GetIpNetworkConnectionBandwidthEstimates

関数

指定接続の帯域幅推定値を取得する。

DLLIPHLPAPI.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

WIN32_ERROR GetIpNetworkConnectionBandwidthEstimates(
    DWORD InterfaceIndex,
    ADDRESS_FAMILY AddressFamily,
    MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* BandwidthEstimates
);

パラメーター

名前

型

方向

説明

InterfaceIndex

DWORD

ネットワークインターフェイスのローカルインデックス値です。

このインデックス値は、ネットワークアダプターが無効化されてから再度有効化された場合や、その他の状況で変化することがあるため、永続的なものとはみなさないでください。

AddressFamily

ADDRESS_FAMILY

アドレスファミリです。アドレスファミリに指定できる値は、Ws2def.h ヘッダーファイルに一覧されています。AF_ アドレスファミリ定数と PF_ プロトコルファミリ定数の値は同一である(たとえば AF_INET と PF_INET)ため、どちらの定数を使用してもかまいません。

なお、Ws2def.h ヘッダーファイルは Winsock2.h に自動的にインクルードされるため、直接使用しないでください。

現在サポートされている値は AF_INET または AF_INET6 で、これらはそれぞれ IPv4 および IPv6 のインターネットアドレスファミリ形式です。

値	意味
AF_INET 2	インターネットプロトコルバージョン4(IPv4)のアドレスファミリです。
AF_INET6 23	インターネットプロトコルバージョン6(IPv6)のアドレスファミリです。

BandwidthEstimates

MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES*

out

インターフェイスが現在接続している接続点について保持されている、過去の帯域幅推定値を返すバッファーへのポインターです。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定されたインターフェイス上のネットワーク接続について、過去の帯域幅推定値を取得します。

戻り値

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

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

戻り値	説明
ERROR_FILE_NOT_FOUND	指定されたファイルが見つかりません。このエラーは、InterfaceIndex パラメーターで指定されたインターフェイスインデックスがローカルマシン上の値ではなかった場合に返されます。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、BandwidthEstimates パラメーターに NULL ポインターが渡された場合、または AddressFamily パラメーターが AF_INET もしくは AF_INET6 として指定されなかった場合に返されます。
ERROR_NOT_FOUND	要素が見つかりません。このエラーは、InterfaceIndex パラメーターで指定されたネットワークインターフェイスが、AddressFamily パラメーターで指定された IP アドレスファミリと一致しない場合に返されます。
その他	返されたエラーに対応するメッセージ文字列を取得するには、FormatMessage 関数を使用してください。

解説(Remarks)

GetIpNetworkConnectionBandwidthEstimates 関数は、Windows 8 以降で定義されています。

入力時、AddressFamily パラメーターは AF_INET または AF_INET6 のいずれかに初期化されている必要があります。さらに入力時、InterfaceIndex パラメーターは指定するインターフェイスインデックスで初期化されている必要があります。

InterfaceIndex パラメーターには値を設定する必要があります(このパラメーターの値をゼロに設定してはなりません)。

出力時、BandwidthEstimates パラメーターが指す MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES 構造体は、AddressFamily および InterfaceIndex パラメーターが指定されていれば値が設定されます。

GetIpNetworkConnectionBandwidthEstimates 関数は、アプリケーションが利用するために、接続点(最初のホップ)における利用可能な帯域幅の過去の推定値を返します。この推定値はパフォーマンスパラメーターを調整するための指針として利用することを想定しており、アプリケーションはしきい値を維持し、低帯域幅および高帯域幅の状況に応じて動作を区別する必要があります。

同じネットワーク上で帯域幅を奪い合うデバイスがより多くの帯域幅を消費するにつれて、実際の利用可能な帯域幅が時間とともに変化する可能性があります。そのため、アプリケーションは、利用可能な帯域幅が GetIpNetworkConnectionBandwidthEstimates 関数によって報告された過去の上限を下回る場合にも対応できるように準備しておく必要があります。

TCP/IP スタックが、指定されたインターフェイスについて、特定の方向または両方向の推定値をまだ構築していない可能性があります。この場合、返される推定値はゼロになります。アプリケーションは、適切なデフォルト値を選択し、必要に応じて微調整を行うことで、こうした場合にも対応できるように準備しておく必要があります。

Netioapi.h ヘッダーファイルは、Iphlpapi.h ヘッダーファイルによって自動的にインクルードされます。Netioapi.h ヘッダーファイルは直接使用しないでください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetIpNetworkConnectionBandwidthEstimates(
    DWORD InterfaceIndex,
    ADDRESS_FAMILY AddressFamily,
    MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* BandwidthEstimates
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpNetworkConnectionBandwidthEstimates(
    uint InterfaceIndex,   // DWORD
    ushort AddressFamily,   // ADDRESS_FAMILY
    IntPtr BandwidthEstimates   // MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpNetworkConnectionBandwidthEstimates(
    InterfaceIndex As UInteger,   ' DWORD
    AddressFamily As UShort,   ' ADDRESS_FAMILY
    BandwidthEstimates As IntPtr   ' MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* out
) As UInteger
End Function

' InterfaceIndex : DWORD
' AddressFamily : ADDRESS_FAMILY
' BandwidthEstimates : MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* out
Declare PtrSafe Function GetIpNetworkConnectionBandwidthEstimates Lib "iphlpapi" ( _
    ByVal InterfaceIndex As Long, _
    ByVal AddressFamily As Integer, _
    ByVal BandwidthEstimates As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetIpNetworkConnectionBandwidthEstimates = ctypes.windll.iphlpapi.GetIpNetworkConnectionBandwidthEstimates
GetIpNetworkConnectionBandwidthEstimates.restype = wintypes.DWORD
GetIpNetworkConnectionBandwidthEstimates.argtypes = [
    wintypes.DWORD,  # InterfaceIndex : DWORD
    ctypes.c_ushort,  # AddressFamily : ADDRESS_FAMILY
    ctypes.c_void_p,  # BandwidthEstimates : MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetIpNetworkConnectionBandwidthEstimates = Fiddle::Function.new(
  lib['GetIpNetworkConnectionBandwidthEstimates'],
  [
    -Fiddle::TYPE_INT,  # InterfaceIndex : DWORD
    -Fiddle::TYPE_SHORT,  # AddressFamily : ADDRESS_FAMILY
    Fiddle::TYPE_VOIDP,  # BandwidthEstimates : MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetIpNetworkConnectionBandwidthEstimates(
        InterfaceIndex: u32,  // DWORD
        AddressFamily: u16,  // ADDRESS_FAMILY
        BandwidthEstimates: *mut MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES  // MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetIpNetworkConnectionBandwidthEstimates(uint InterfaceIndex, ushort AddressFamily, IntPtr BandwidthEstimates);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetIpNetworkConnectionBandwidthEstimates' -Namespace Win32 -PassThru
# $api::GetIpNetworkConnectionBandwidthEstimates(InterfaceIndex, AddressFamily, BandwidthEstimates)

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

出力引数:

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