Win32 API 日本語リファレンス
ホームNetworkManagement.IpHelper › PfGetInterfaceStatistics

PfGetInterfaceStatistics

関数
パケットフィルタインターフェイスの統計情報を取得する。
DLLIPHLPAPI.dll呼出規約winapi

シグネチャ

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

DWORD PfGetInterfaceStatistics(
    void* pInterface,
    PF_INTERFACE_STATS* ppfStats,
    DWORD* pdwBufferSize,
    BOOL fResetCounters
);

パラメーター

名前方向説明
pInterfacevoid*inout統計を取得する対象インターフェースのハンドル。
ppfStatsPF_INTERFACE_STATS*inout統計情報を受け取るPF_INTERFACE_STATS構造体へのポインタ。
pdwBufferSizeDWORD*inoutバッファサイズを渡し、必要サイズを受け取る入出力ポインタ(バイト単位)。
fResetCountersBOOLinTRUEで取得後に統計カウンタをリセットする。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD PfGetInterfaceStatistics(
    void* pInterface,
    PF_INTERFACE_STATS* ppfStats,
    DWORD* pdwBufferSize,
    BOOL fResetCounters
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint PfGetInterfaceStatistics(
    IntPtr pInterface,   // void* in/out
    IntPtr ppfStats,   // PF_INTERFACE_STATS* in/out
    ref uint pdwBufferSize,   // DWORD* in/out
    bool fResetCounters   // BOOL
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function PfGetInterfaceStatistics(
    pInterface As IntPtr,   ' void* in/out
    ppfStats As IntPtr,   ' PF_INTERFACE_STATS* in/out
    ByRef pdwBufferSize As UInteger,   ' DWORD* in/out
    fResetCounters As Boolean   ' BOOL
) As UInteger
End Function
' pInterface : void* in/out
' ppfStats : PF_INTERFACE_STATS* in/out
' pdwBufferSize : DWORD* in/out
' fResetCounters : BOOL
Declare PtrSafe Function PfGetInterfaceStatistics Lib "iphlpapi" ( _
    ByVal pInterface As LongPtr, _
    ByVal ppfStats As LongPtr, _
    ByRef pdwBufferSize As Long, _
    ByVal fResetCounters As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PfGetInterfaceStatistics = ctypes.windll.iphlpapi.PfGetInterfaceStatistics
PfGetInterfaceStatistics.restype = wintypes.DWORD
PfGetInterfaceStatistics.argtypes = [
    ctypes.POINTER(None),  # pInterface : void* in/out
    ctypes.c_void_p,  # ppfStats : PF_INTERFACE_STATS* in/out
    ctypes.POINTER(wintypes.DWORD),  # pdwBufferSize : DWORD* in/out
    wintypes.BOOL,  # fResetCounters : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
PfGetInterfaceStatistics = Fiddle::Function.new(
  lib['PfGetInterfaceStatistics'],
  [
    Fiddle::TYPE_VOIDP,  # pInterface : void* in/out
    Fiddle::TYPE_VOIDP,  # ppfStats : PF_INTERFACE_STATS* in/out
    Fiddle::TYPE_VOIDP,  # pdwBufferSize : DWORD* in/out
    Fiddle::TYPE_INT,  # fResetCounters : BOOL
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn PfGetInterfaceStatistics(
        pInterface: *mut (),  // void* in/out
        ppfStats: *mut PF_INTERFACE_STATS,  // PF_INTERFACE_STATS* in/out
        pdwBufferSize: *mut u32,  // DWORD* in/out
        fResetCounters: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint PfGetInterfaceStatistics(IntPtr pInterface, IntPtr ppfStats, ref uint pdwBufferSize, bool fResetCounters);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_PfGetInterfaceStatistics' -Namespace Win32 -PassThru
# $api::PfGetInterfaceStatistics(pInterface, ppfStats, pdwBufferSize, fResetCounters)
#uselib "IPHLPAPI.dll"
#func global PfGetInterfaceStatistics "PfGetInterfaceStatistics" sptr, sptr, sptr, sptr
; PfGetInterfaceStatistics pInterface, varptr(ppfStats), varptr(pdwBufferSize), fResetCounters   ; 戻り値は stat
; pInterface : void* in/out -> "sptr"
; ppfStats : PF_INTERFACE_STATS* in/out -> "sptr"
; pdwBufferSize : DWORD* in/out -> "sptr"
; fResetCounters : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IPHLPAPI.dll"
#cfunc global PfGetInterfaceStatistics "PfGetInterfaceStatistics" sptr, var, var, int
; res = PfGetInterfaceStatistics(pInterface, ppfStats, pdwBufferSize, fResetCounters)
; pInterface : void* in/out -> "sptr"
; ppfStats : PF_INTERFACE_STATS* in/out -> "var"
; pdwBufferSize : DWORD* in/out -> "var"
; fResetCounters : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD PfGetInterfaceStatistics(void* pInterface, PF_INTERFACE_STATS* ppfStats, DWORD* pdwBufferSize, BOOL fResetCounters)
#uselib "IPHLPAPI.dll"
#cfunc global PfGetInterfaceStatistics "PfGetInterfaceStatistics" intptr, var, var, int
; res = PfGetInterfaceStatistics(pInterface, ppfStats, pdwBufferSize, fResetCounters)
; pInterface : void* in/out -> "intptr"
; ppfStats : PF_INTERFACE_STATS* in/out -> "var"
; pdwBufferSize : DWORD* in/out -> "var"
; fResetCounters : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procPfGetInterfaceStatistics = iphlpapi.NewProc("PfGetInterfaceStatistics")
)

// pInterface (void* in/out), ppfStats (PF_INTERFACE_STATS* in/out), pdwBufferSize (DWORD* in/out), fResetCounters (BOOL)
r1, _, err := procPfGetInterfaceStatistics.Call(
	uintptr(pInterface),
	uintptr(ppfStats),
	uintptr(pdwBufferSize),
	uintptr(fResetCounters),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PfGetInterfaceStatistics(
  pInterface: Pointer;   // void* in/out
  ppfStats: Pointer;   // PF_INTERFACE_STATS* in/out
  pdwBufferSize: Pointer;   // DWORD* in/out
  fResetCounters: BOOL   // BOOL
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'PfGetInterfaceStatistics';
result := DllCall("IPHLPAPI\PfGetInterfaceStatistics"
    , "Ptr", pInterface   ; void* in/out
    , "Ptr", ppfStats   ; PF_INTERFACE_STATS* in/out
    , "Ptr", pdwBufferSize   ; DWORD* in/out
    , "Int", fResetCounters   ; BOOL
    , "UInt")   ; return: DWORD
●PfGetInterfaceStatistics(pInterface, ppfStats, pdwBufferSize, fResetCounters) = DLL("IPHLPAPI.dll", "dword PfGetInterfaceStatistics(void*, void*, void*, bool)")
# 呼び出し: PfGetInterfaceStatistics(pInterface, ppfStats, pdwBufferSize, fResetCounters)
# pInterface : void* in/out -> "void*"
# ppfStats : PF_INTERFACE_STATS* in/out -> "void*"
# pdwBufferSize : DWORD* in/out -> "void*"
# fResetCounters : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn PfGetInterfaceStatistics(
    pInterface: ?*anyopaque, // void* in/out
    ppfStats: [*c]PF_INTERFACE_STATS, // PF_INTERFACE_STATS* in/out
    pdwBufferSize: [*c]u32, // DWORD* in/out
    fResetCounters: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
proc PfGetInterfaceStatistics(
    pInterface: pointer,  # void* in/out
    ppfStats: ptr PF_INTERFACE_STATS,  # PF_INTERFACE_STATS* in/out
    pdwBufferSize: ptr uint32,  # DWORD* in/out
    fResetCounters: int32  # BOOL
): uint32 {.importc: "PfGetInterfaceStatistics", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint PfGetInterfaceStatistics(
    void* pInterface,   // void* in/out
    PF_INTERFACE_STATS* ppfStats,   // PF_INTERFACE_STATS* in/out
    uint* pdwBufferSize,   // DWORD* in/out
    int fResetCounters   // BOOL
);
ccall((:PfGetInterfaceStatistics, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{PF_INTERFACE_STATS}, Ptr{UInt32}, Int32),
      pInterface, ppfStats, pdwBufferSize, fResetCounters)
# pInterface : void* in/out -> Ptr{Cvoid}
# ppfStats : PF_INTERFACE_STATS* in/out -> Ptr{PF_INTERFACE_STATS}
# pdwBufferSize : DWORD* in/out -> Ptr{UInt32}
# fResetCounters : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PfGetInterfaceStatistics(
    void* pInterface,
    void* ppfStats,
    uint32_t* pdwBufferSize,
    int32_t fResetCounters);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.PfGetInterfaceStatistics(pInterface, ppfStats, pdwBufferSize, fResetCounters)
-- pInterface : void* in/out
-- ppfStats : PF_INTERFACE_STATS* in/out
-- pdwBufferSize : DWORD* in/out
-- fResetCounters : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const PfGetInterfaceStatistics = lib.func('__stdcall', 'PfGetInterfaceStatistics', 'uint32_t', ['void *', 'void *', 'uint32_t *', 'int32_t']);
// PfGetInterfaceStatistics(pInterface, ppfStats, pdwBufferSize, fResetCounters)
// pInterface : void* in/out -> 'void *'
// ppfStats : PF_INTERFACE_STATS* in/out -> 'void *'
// pdwBufferSize : DWORD* in/out -> 'uint32_t *'
// fResetCounters : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  PfGetInterfaceStatistics: { parameters: ["pointer", "pointer", "pointer", "i32"], result: "u32" },
});
// lib.symbols.PfGetInterfaceStatistics(pInterface, ppfStats, pdwBufferSize, fResetCounters)
// pInterface : void* in/out -> "pointer"
// ppfStats : PF_INTERFACE_STATS* in/out -> "pointer"
// pdwBufferSize : DWORD* in/out -> "pointer"
// fResetCounters : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PfGetInterfaceStatistics(
    void* pInterface,
    void* ppfStats,
    uint32_t* pdwBufferSize,
    int32_t fResetCounters);
C, "IPHLPAPI.dll");
// $ffi->PfGetInterfaceStatistics(pInterface, ppfStats, pdwBufferSize, fResetCounters);
// pInterface : void* in/out
// ppfStats : PF_INTERFACE_STATS* in/out
// pdwBufferSize : DWORD* in/out
// fResetCounters : BOOL
// 構造体/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 PfGetInterfaceStatistics(
        Pointer pInterface,   // void* in/out
        Pointer ppfStats,   // PF_INTERFACE_STATS* in/out
        IntByReference pdwBufferSize,   // DWORD* in/out
        boolean fResetCounters   // BOOL
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun PfGetInterfaceStatistics = PfGetInterfaceStatistics(
    pInterface : Void*,   # void* in/out
    ppfStats : PF_INTERFACE_STATS*,   # PF_INTERFACE_STATS* in/out
    pdwBufferSize : UInt32*,   # DWORD* in/out
    fResetCounters : Int32   # BOOL
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PfGetInterfaceStatisticsNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>, Int32);
typedef PfGetInterfaceStatisticsDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>, int);
final PfGetInterfaceStatistics = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<PfGetInterfaceStatisticsNative, PfGetInterfaceStatisticsDart>('PfGetInterfaceStatistics');
// pInterface : void* in/out -> Pointer<Void>
// ppfStats : PF_INTERFACE_STATS* in/out -> Pointer<Void>
// pdwBufferSize : DWORD* in/out -> Pointer<Uint32>
// fResetCounters : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PfGetInterfaceStatistics(
  pInterface: Pointer;   // void* in/out
  ppfStats: Pointer;   // PF_INTERFACE_STATS* in/out
  pdwBufferSize: Pointer;   // DWORD* in/out
  fResetCounters: BOOL   // BOOL
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'PfGetInterfaceStatistics';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PfGetInterfaceStatistics"
  c_PfGetInterfaceStatistics :: Ptr () -> Ptr () -> Ptr Word32 -> CInt -> IO Word32
-- pInterface : void* in/out -> Ptr ()
-- ppfStats : PF_INTERFACE_STATS* in/out -> Ptr ()
-- pdwBufferSize : DWORD* in/out -> Ptr Word32
-- fResetCounters : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pfgetinterfacestatistics =
  foreign "PfGetInterfaceStatistics"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> int32_t @-> returning uint32_t)
(* pInterface : void* in/out -> (ptr void) *)
(* ppfStats : PF_INTERFACE_STATS* in/out -> (ptr void) *)
(* pdwBufferSize : DWORD* in/out -> (ptr uint32_t) *)
(* fResetCounters : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("PfGetInterfaceStatistics" pf-get-interface-statistics :convention :stdcall) :uint32
  (p-interface :pointer)   ; void* in/out
  (ppf-stats :pointer)   ; PF_INTERFACE_STATS* in/out
  (pdw-buffer-size :pointer)   ; DWORD* in/out
  (f-reset-counters :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PfGetInterfaceStatistics = Win32::API::More->new('IPHLPAPI',
    'DWORD PfGetInterfaceStatistics(LPVOID pInterface, LPVOID ppfStats, LPVOID pdwBufferSize, BOOL fResetCounters)');
# my $ret = $PfGetInterfaceStatistics->Call($pInterface, $ppfStats, $pdwBufferSize, $fResetCounters);
# pInterface : void* in/out -> LPVOID
# ppfStats : PF_INTERFACE_STATS* in/out -> LPVOID
# pdwBufferSize : DWORD* in/out -> LPVOID
# fResetCounters : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型