ホーム › NetworkManagement.IpHelper › GetRTTAndHopCount

GetRTTAndHopCount

関数

指定宛先までの往復時間とホップ数を取得する。

DLLIPHLPAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetRTTAndHopCount(
    DWORD DestIpAddress,
    DWORD* HopCount,
    DWORD MaxHops,
    DWORD* RTT
);

パラメーター

名前	型	方向	説明
DestIpAddress	DWORD	in	RTT とホップ数を求める対象となる宛先の IP アドレス。IPAddr 構造体の形式で指定します。
HopCount	DWORD*	out	ULONG 変数へのポインター。この変数は、DestIpAddress パラメーターで指定された宛先までのホップ数を受け取ります。
MaxHops	DWORD	in	宛先を探索する際の最大ホップ数。宛先までのホップ数がこの値を超える場合、関数は探索を終了し FALSE を返します。
RTT	DWORD*	out	DestIpAddress で指定された宛先までのラウンドトリップ時間 (ミリ秒単位)。

戻り値の型: BOOL

公式ドキュメント

GetRTTAndHopCount 関数は、指定された宛先までのラウンドトリップ時間 (RTT) とホップ数を求めます。

戻り値

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

関数が失敗した場合、戻り値は FALSE です。 GetLastError を呼び出して、失敗の原因を示すエラーコードを取得してください。

解説(Remarks)

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

例

次の例では、宛先 IP アドレス 127.0.0.1 までのラウンドトリップ時間とホップ数を取得して出力します。

UINT ip = inet_addr("127.0.0.1");
ULONG hopCount = 0;
ULONG RTT = 0;

if(GetRTTAndHopCount(ip, &hopCount, 30, &RTT) == TRUE) {
  printf("Hops: %ld\n", hopCount);
  printf("RTT: %ld\n", RTT);
}
else {
  printf("Error: %ld\n", GetLastError());
}

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

各言語での呼び出し定義

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

BOOL GetRTTAndHopCount(
    DWORD DestIpAddress,
    DWORD* HopCount,
    DWORD MaxHops,
    DWORD* RTT
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IPHLPAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetRTTAndHopCount(
    uint DestIpAddress,   // DWORD
    out uint HopCount,   // DWORD* out
    uint MaxHops,   // DWORD
    out uint RTT   // DWORD* out
);

<DllImport("IPHLPAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetRTTAndHopCount(
    DestIpAddress As UInteger,   ' DWORD
    <Out> ByRef HopCount As UInteger,   ' DWORD* out
    MaxHops As UInteger,   ' DWORD
    <Out> ByRef RTT As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

GetRTTAndHopCount = ctypes.windll.iphlpapi.GetRTTAndHopCount
GetRTTAndHopCount.restype = wintypes.BOOL
GetRTTAndHopCount.argtypes = [
    wintypes.DWORD,  # DestIpAddress : DWORD
    ctypes.POINTER(wintypes.DWORD),  # HopCount : DWORD* out
    wintypes.DWORD,  # MaxHops : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RTT : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetRTTAndHopCount = Fiddle::Function.new(
  lib['GetRTTAndHopCount'],
  [
    -Fiddle::TYPE_INT,  # DestIpAddress : DWORD
    Fiddle::TYPE_VOIDP,  # HopCount : DWORD* out
    -Fiddle::TYPE_INT,  # MaxHops : DWORD
    Fiddle::TYPE_VOIDP,  # RTT : DWORD* out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("IPHLPAPI.dll", SetLastError = true)]
public static extern bool GetRTTAndHopCount(uint DestIpAddress, out uint HopCount, uint MaxHops, out uint RTT);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetRTTAndHopCount' -Namespace Win32 -PassThru
# $api::GetRTTAndHopCount(DestIpAddress, HopCount, MaxHops, RTT)

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

出力引数:

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