ホーム › NetworkManagement.IpHelper › GetIcmpStatisticsEx

GetIcmpStatisticsEx

関数

指定アドレスファミリのICMPプロトコル統計情報を取得する。

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

シグネチャ

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

DWORD GetIcmpStatisticsEx(
    MIB_ICMP_EX_XPSP1* Statistics,
    DWORD Family
);

パラメーター

名前

型

方向

説明

Statistics

MIB_ICMP_EX_XPSP1*

out

ローカルコンピューターの ICMP 統計情報を格納する MIB_ICMP_EX 構造体へのポインターです。

Family

DWORD

ICMP 統計情報を取得する対象のプロトコルファミリーです。次のいずれかである必要があります。

値	意味
AF_INET	Internet Protocol version 4 (IPv4)。
AF_INET6	Internet Protocol version 6 (IPv6)。

戻り値の型: DWORD

公式ドキュメント

GetIcmpStatisticsEx 関数は、ローカルコンピューターの Internet Control Message Protocol (ICMP) 統計情報を取得します。GetIcmpStatisticsEx 関数は、IPv6 の ICMP 統計情報を取得することができます。

戻り値

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

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

戻りコード	説明
ERROR_INVALID_PARAMETER	pStats パラメーターが NULL であるか有効なメモリを指していない、または dwFamily パラメーターが有効な値ではありません。
ERROR_NOT_SUPPORTED	この関数は、関数呼び出しが行われたオペレーティングシステムではサポートされていません。
その他	返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

GetIpStatisticsEx は、ローカルコンピューターの IPv4 または IPv6 のいずれかの ICMP 統計情報を取得するために使用できます。

GetIcmpStatistics 関数は、ローカルコンピューターの IPv4 のみの ICMP 統計情報を返します。

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

各言語での呼び出し定義

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

DWORD GetIcmpStatisticsEx(
    MIB_ICMP_EX_XPSP1* Statistics,
    DWORD Family
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIcmpStatisticsEx(
    IntPtr Statistics,   // MIB_ICMP_EX_XPSP1* out
    uint Family   // DWORD
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIcmpStatisticsEx(
    Statistics As IntPtr,   ' MIB_ICMP_EX_XPSP1* out
    Family As UInteger   ' DWORD
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

GetIcmpStatisticsEx = ctypes.windll.iphlpapi.GetIcmpStatisticsEx
GetIcmpStatisticsEx.restype = wintypes.DWORD
GetIcmpStatisticsEx.argtypes = [
    ctypes.c_void_p,  # Statistics : MIB_ICMP_EX_XPSP1* out
    wintypes.DWORD,  # Family : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetIcmpStatisticsEx = Fiddle::Function.new(
  lib['GetIcmpStatisticsEx'],
  [
    Fiddle::TYPE_VOIDP,  # Statistics : MIB_ICMP_EX_XPSP1* out
    -Fiddle::TYPE_INT,  # Family : DWORD
  ],
  -Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetIcmpStatisticsEx(IntPtr Statistics, uint Family);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetIcmpStatisticsEx' -Namespace Win32 -PassThru
# $api::GetIcmpStatisticsEx(Statistics, Family)

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

出力引数:

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