Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
InterfaceIndexDWORDin
AddressFamilyADDRESS_FAMILYin
BandwidthEstimatesMIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES*out

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; WIN32_ERROR GetIpNetworkConnectionBandwidthEstimates(DWORD InterfaceIndex, ADDRESS_FAMILY AddressFamily, MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* BandwidthEstimates)
#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 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIpNetworkConnectionBandwidthEstimates = iphlpapi.NewProc("GetIpNetworkConnectionBandwidthEstimates")
)

// InterfaceIndex (DWORD), AddressFamily (ADDRESS_FAMILY), BandwidthEstimates (MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* out)
r1, _, err := procGetIpNetworkConnectionBandwidthEstimates.Call(
	uintptr(InterfaceIndex),
	uintptr(AddressFamily),
	uintptr(BandwidthEstimates),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function GetIpNetworkConnectionBandwidthEstimates(
  InterfaceIndex: DWORD;   // DWORD
  AddressFamily: Word;   // ADDRESS_FAMILY
  BandwidthEstimates: Pointer   // MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIpNetworkConnectionBandwidthEstimates';
result := DllCall("IPHLPAPI\GetIpNetworkConnectionBandwidthEstimates"
    , "UInt", InterfaceIndex   ; DWORD
    , "UShort", AddressFamily   ; ADDRESS_FAMILY
    , "Ptr", BandwidthEstimates   ; MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* out
    , "UInt")   ; return: WIN32_ERROR
●GetIpNetworkConnectionBandwidthEstimates(InterfaceIndex, AddressFamily, BandwidthEstimates) = DLL("IPHLPAPI.dll", "dword GetIpNetworkConnectionBandwidthEstimates(dword, int, void*)")
# 呼び出し: GetIpNetworkConnectionBandwidthEstimates(InterfaceIndex, AddressFamily, BandwidthEstimates)
# InterfaceIndex : DWORD -> "dword"
# AddressFamily : ADDRESS_FAMILY -> "int"
# BandwidthEstimates : MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。