ホーム › NetworkManagement.IpHelper › GetIpStatistics
GetIpStatistics
関数IPプロトコルの統計情報を取得する。
シグネチャ
// IPHLPAPI.dll
#include <windows.h>
DWORD GetIpStatistics(
MIB_IPSTATS_LH* Statistics
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Statistics | MIB_IPSTATS_LH* | out | ローカルコンピューターの IP 統計情報を受け取る MIB_IPSTATS 構造体へのポインター。 |
戻り値の型: DWORD
公式ドキュメント
GetIpStatistics 関数は、現在のコンピューターの IP 統計情報を取得します。
戻り値
関数が成功した場合、戻り値は NO_ERROR です。
関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。
| 戻り値 | 説明 |
|---|---|
| pStats パラメーターが NULL であるか、 GetIpStatistics が pStats パラメーターの指すメモリに書き込めません。 | |
|
FormatMessage 関数を使用して、返されたエラーに対応するメッセージ文字列を取得してください。 |
解説(Remarks)
GetIpStatistics 関数は、現在のコンピューターの IPv4 に関する統計情報を返します。 Windows XP 以降では、GetIpStatisticsEx を使用して、IPv4 または IPv6 のいずれかの IP 統計情報を取得できます。
例
次の例では、ローカルコンピューターの IPv4 統計情報を取得し、返されたデータの値を出力します。
#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;
MIB_IPSTATS *pStats;
pStats = (MIB_IPSTATS *) MALLOC(sizeof (MIB_IPSTATS));
if (pStats == NULL) {
wprintf(L"Unable to allocate memory for MIB_IPSTATS\n");
exit(1);
}
dwRetval = GetIpStatistics(pStats);
if (dwRetval != NO_ERROR) {
wprintf(L"GetIpStatistics call failed with %d\n", dwRetval);
exit(1);
} else {
wprintf(L"IP forwarding: \t\t" );
switch (pStats->dwForwarding) {
case MIB_IP_FORWARDING:
wprintf(L"Enabled\n");
break;
case MIB_IP_NOT_FORWARDING:
wprintf(L"Disabled\n");
break;
default:
wprintf(L"unknown value = %d\n", pStats->dwForwarding);
break;
}
wprintf(L"Default initial TTL: \t\t\t\t\t%u\n", pStats->dwDefaultTTL);
wprintf(L"Number of received datagrams: \t\t\t\t%u\n", pStats->dwInReceives);
wprintf(L"Number of received datagrams with header errors: \t%u\n", pStats->dwInHdrErrors);
wprintf(L"Number of received datagrams with address errors: \t%u\n", pStats->dwInAddrErrors);
wprintf(L"Number of datagrams forwarded: \t\t\t\t%ld\n", pStats->dwForwDatagrams);
wprintf(L"Number of received datagrams with an unknown protocol: \t%u\n", pStats->dwInUnknownProtos);
wprintf(L"Number of received datagrams discarded: \t\t%u\n", pStats->dwInDiscards);
wprintf(L"Number of received datagrams delivered: \t\t%u\n", pStats->dwInDelivers);
wprintf(L"Number of outgoing datagrams requested to transmit: \t%u\n", pStats->dwOutRequests);
wprintf(L"Number of outgoing datagrams discarded for routing: \t%u\n", pStats->dwRoutingDiscards);
wprintf(L"Number of outgoing datagrams discarded: \t\t%u\n", pStats->dwOutDiscards);
wprintf(L"Number of outgoing datagrams with no route to destination discarded: %u\n", pStats->dwOutNoRoutes);
wprintf(L"Fragment reassembly timeout: \t\t\t\t%u\n", pStats->dwReasmTimeout);
wprintf(L"Number of datagrams that required reassembly: \t\t%u\n", pStats->dwReasmReqds);
wprintf(L"Number of datagrams successfully reassembled: \t\t%u\n", pStats->dwReasmOks);
wprintf(L"Number of datagrams that could not be reassembled: \t%u\n", pStats->dwReasmFails);
wprintf(L"Number of datagrams fragmented successfully: \t\t%u\n", pStats->dwFragOks);
wprintf(L"Number of datagrams not fragmented and discarded: \t%u\n", pStats->dwFragFails);
wprintf(L"Number of fragments created: \t\t\t\t%u\n", pStats->dwFragCreates);
wprintf(L"Number of interfaces: \t\t\t\t\t%u\n", pStats->dwNumIf);
wprintf(L"Number of IP addresses: \t\t\t\t%u\n", pStats->dwNumAddr);
wprintf(L"Number of routes: \t\t\t\t\t%u\n", pStats->dwNumRoutes);
}
// Free memory allocated for the MIB_IPSTATS structure
if (pStats)
FREE(pStats);
return 0;
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
DWORD GetIpStatistics(
MIB_IPSTATS_LH* Statistics
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpStatistics(
IntPtr Statistics // MIB_IPSTATS_LH* out
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpStatistics(
Statistics As IntPtr ' MIB_IPSTATS_LH* out
) As UInteger
End Function' Statistics : MIB_IPSTATS_LH* out
Declare PtrSafe Function GetIpStatistics 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
GetIpStatistics = ctypes.windll.iphlpapi.GetIpStatistics
GetIpStatistics.restype = wintypes.DWORD
GetIpStatistics.argtypes = [
ctypes.c_void_p, # Statistics : MIB_IPSTATS_LH* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
GetIpStatistics = Fiddle::Function.new(
lib['GetIpStatistics'],
[
Fiddle::TYPE_VOIDP, # Statistics : MIB_IPSTATS_LH* out
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn GetIpStatistics(
Statistics: *mut MIB_IPSTATS_LH // MIB_IPSTATS_LH* out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetIpStatistics(IntPtr Statistics);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetIpStatistics' -Namespace Win32 -PassThru
# $api::GetIpStatistics(Statistics)#uselib "IPHLPAPI.dll"
#func global GetIpStatistics "GetIpStatistics" sptr
; GetIpStatistics varptr(Statistics) ; 戻り値は stat
; Statistics : MIB_IPSTATS_LH* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "IPHLPAPI.dll" #cfunc global GetIpStatistics "GetIpStatistics" var ; res = GetIpStatistics(Statistics) ; Statistics : MIB_IPSTATS_LH* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll" #cfunc global GetIpStatistics "GetIpStatistics" sptr ; res = GetIpStatistics(varptr(Statistics)) ; Statistics : MIB_IPSTATS_LH* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD GetIpStatistics(MIB_IPSTATS_LH* Statistics) #uselib "IPHLPAPI.dll" #cfunc global GetIpStatistics "GetIpStatistics" var ; res = GetIpStatistics(Statistics) ; Statistics : MIB_IPSTATS_LH* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD GetIpStatistics(MIB_IPSTATS_LH* Statistics) #uselib "IPHLPAPI.dll" #cfunc global GetIpStatistics "GetIpStatistics" intptr ; res = GetIpStatistics(varptr(Statistics)) ; Statistics : MIB_IPSTATS_LH* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procGetIpStatistics = iphlpapi.NewProc("GetIpStatistics")
)
// Statistics (MIB_IPSTATS_LH* out)
r1, _, err := procGetIpStatistics.Call(
uintptr(Statistics),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction GetIpStatistics(
Statistics: Pointer // MIB_IPSTATS_LH* out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'GetIpStatistics';result := DllCall("IPHLPAPI\GetIpStatistics"
, "Ptr", Statistics ; MIB_IPSTATS_LH* out
, "UInt") ; return: DWORD●GetIpStatistics(Statistics) = DLL("IPHLPAPI.dll", "dword GetIpStatistics(void*)")
# 呼び出し: GetIpStatistics(Statistics)
# Statistics : MIB_IPSTATS_LH* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn GetIpStatistics(
Statistics: [*c]MIB_IPSTATS_LH // MIB_IPSTATS_LH* out
) callconv(std.os.windows.WINAPI) u32;proc GetIpStatistics(
Statistics: ptr MIB_IPSTATS_LH # MIB_IPSTATS_LH* out
): uint32 {.importc: "GetIpStatistics", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint GetIpStatistics(
MIB_IPSTATS_LH* Statistics // MIB_IPSTATS_LH* out
);ccall((:GetIpStatistics, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{MIB_IPSTATS_LH},),
Statistics)
# Statistics : MIB_IPSTATS_LH* out -> Ptr{MIB_IPSTATS_LH}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t GetIpStatistics(
void* Statistics);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetIpStatistics(Statistics)
-- Statistics : MIB_IPSTATS_LH* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetIpStatistics = lib.func('__stdcall', 'GetIpStatistics', 'uint32_t', ['void *']);
// GetIpStatistics(Statistics)
// Statistics : MIB_IPSTATS_LH* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
GetIpStatistics: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.GetIpStatistics(Statistics)
// Statistics : MIB_IPSTATS_LH* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t GetIpStatistics(
void* Statistics);
C, "IPHLPAPI.dll");
// $ffi->GetIpStatistics(Statistics);
// Statistics : MIB_IPSTATS_LH* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Iphlpapi extends StdCallLibrary {
Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
int GetIpStatistics(
Pointer Statistics // MIB_IPSTATS_LH* out
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun GetIpStatistics = GetIpStatistics(
Statistics : MIB_IPSTATS_LH* # MIB_IPSTATS_LH* out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetIpStatisticsNative = Uint32 Function(Pointer<Void>);
typedef GetIpStatisticsDart = int Function(Pointer<Void>);
final GetIpStatistics = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<GetIpStatisticsNative, GetIpStatisticsDart>('GetIpStatistics');
// Statistics : MIB_IPSTATS_LH* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetIpStatistics(
Statistics: Pointer // MIB_IPSTATS_LH* out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'GetIpStatistics';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetIpStatistics"
c_GetIpStatistics :: Ptr () -> IO Word32
-- Statistics : MIB_IPSTATS_LH* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getipstatistics =
foreign "GetIpStatistics"
((ptr void) @-> returning uint32_t)
(* Statistics : MIB_IPSTATS_LH* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)
(cffi:defcfun ("GetIpStatistics" get-ip-statistics :convention :stdcall) :uint32
(statistics :pointer)) ; MIB_IPSTATS_LH* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetIpStatistics = Win32::API::More->new('IPHLPAPI',
'DWORD GetIpStatistics(LPVOID Statistics)');
# my $ret = $GetIpStatistics->Call($Statistics);
# Statistics : MIB_IPSTATS_LH* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
類似 API
- f GetIpStatisticsEx — 指定アドレスファミリのIPプロトコル統計情報を取得する。
公式の関連項目
- f GetIcmpStatistics — ICMPプロトコルの統計情報を取得する。
- f GetTcpStatistics — TCPプロトコルの統計情報を取得する。
- f GetUdpStatistics — UDPプロトコルの統計情報を取得する。
使用する型