ホーム › NetworkManagement.IpHelper › GetIcmpStatistics

GetIcmpStatistics

関数

ICMPプロトコルの統計情報を取得する。

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

シグネチャ

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

DWORD GetIcmpStatistics(
    MIB_ICMP* Statistics
);

パラメーター

名前	型	方向	説明
Statistics	MIB_ICMP*	out	ローカルコンピューターの ICMP 統計情報を受け取る MIB_ICMP 構造体へのポインター。

戻り値の型: DWORD

公式ドキュメント

GetIcmpStatistics 関数は、ローカルコンピューターの IPv4 用 Internet Control Message Protocol (ICMP) 統計情報を取得します。

戻り値

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

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

戻り値	説明
ERROR_INVALID_PARAMETER	pStats パラメーターが NULL であるか、 GetIcmpStatistics が pStats パラメーターで指されているメモリに書き込めません。
その他	返されたエラーに対応するメッセージ文字列を取得するには、 FormatMessage 関数を使用してください。

解説(Remarks)

GetIcmpStatistics 関数は、ローカルコンピューターの IPv4 用 ICMP 統計情報を返します。 Windows XP 以降では、GetIpStatisticsEx を使用して、ローカルコンピューターの IPv4 または IPv6 のいずれかの ICMP 統計情報を取得できます。

例

次の例では、ローカルコンピューターの IPv4 用 ICMP 統計情報を取得し、返されたデータから一部の情報を表示します。

#ifndef UNICODE
#define UNICODE
#endif

#include <winsock2.h>
#include <ws2tcpip.h>
#include <iphlpapi.h>
#include <stdio.h>

#pragma comment(lib, "iphlpapi.lib")

#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x))
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))

/* Note: could also use malloc() and free() */

int main()
{

    DWORD dwRetVal = 0;
    PMIB_ICMP pIcmpStats;

    pIcmpStats = (MIB_ICMP *) MALLOC(sizeof (MIB_ICMP));
    if (pIcmpStats == NULL) {
        wprintf(L"Error allocating memory\n");
        return 1;
    }

    dwRetVal = GetIcmpStatistics(pIcmpStats);
    if (dwRetVal == NO_ERROR) {
        wprintf(L"Number of incoming ICMP messages: %ld\n",
                pIcmpStats->stats.icmpInStats.dwMsgs);
        wprintf(L"Number of incoming ICMP errors received: %ld\n",
                pIcmpStats->stats.icmpInStats.dwErrors);
        wprintf(L"Number of outgoing ICMP messages: %ld\n",
                pIcmpStats->stats.icmpOutStats.dwMsgs);
        wprintf(L"Number of outgoing ICMP errors sent: %ld\n",
                pIcmpStats->stats.icmpOutStats.dwErrors);
    } else {
        wprintf(L"GetIcmpStatistics failed with error: %ld\n", dwRetVal);
    }

    if (pIcmpStats)
        FREE(pIcmpStats);

    return 0;
}

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

各言語での呼び出し定義

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

DWORD GetIcmpStatistics(
    MIB_ICMP* Statistics
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIcmpStatistics(
    IntPtr Statistics   // MIB_ICMP* out
);

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

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

import ctypes
from ctypes import wintypes

GetIcmpStatistics = ctypes.windll.iphlpapi.GetIcmpStatistics
GetIcmpStatistics.restype = wintypes.DWORD
GetIcmpStatistics.argtypes = [
    ctypes.c_void_p,  # Statistics : MIB_ICMP* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetIcmpStatistics = Fiddle::Function.new(
  lib['GetIcmpStatistics'],
  [
    Fiddle::TYPE_VOIDP,  # Statistics : MIB_ICMP* out
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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