Win32 API 日本語リファレンス
ホームSystem.Performance › PerfQueryCounterData

PerfQueryCounterData

関数
照会対象カウンターの現在値データを取得する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

DWORD PerfQueryCounterData(
    HANDLE hQuery,
    PERF_DATA_HEADER* pCounterBlock,   // optional
    DWORD cbCounterBlock,
    DWORD* pcbCounterBlockActual
);

パラメーター

名前方向説明
hQueryHANDLEin値を取得したいパフォーマンスカウンターのカウンター指定を表すクエリへのハンドル。
pCounterBlockPERF_DATA_HEADER*outoptionalcbCounterBlock パラメーターで指定したバイト数のデータを受け取るのに十分な領域を持つバッファーへのポインター。cbCounterBlock が 0 の場合は NULL でもかまいません。
cbCounterBlockDWORDinpCounterBlock パラメーターで指定したバッファーのサイズ(バイト単位)。
pcbCounterBlockActualDWORD*out

パフォーマンスカウンターの値を取得するために実際に必要なバッファーのサイズ。意味は関数が返す値によって異なります。

関数の戻り値 pcbCounterBlockActual の意味
ERROR_SUCCESS pCounterBlock で指定したバッファーに関数が格納したパフォーマンスカウンター値のバイト数。
ERROR_NOT_ENOUGH_MEMORY パフォーマンスカウンター値を格納するために必要なバッファーのサイズ(バイト単位)。バッファーを必要なサイズまで拡大し、関数を再度呼び出してください。
その他 値は未定義であり、使用しないでください。

戻り値の型: DWORD

公式ドキュメント

指定したクエリ内のカウンター指定に一致するパフォーマンスカウンターの値を取得します。

戻り値

戻り値 説明
ERROR_SUCCESS
要求されたすべてのパフォーマンスカウンター値が、pCounterBlock で指定したバッファーに正常に格納されました。pcbCounterBlockActual が指す値は、バッファーに実際に格納された情報量(バイト単位)を示します。
ERROR_NOT_ENOUGH_MEMORY
pCounterBlock で指定したバッファーが、要求されたすべてのパフォーマンスカウンター値を格納するのに十分な大きさではありませんでした。pcbCounterBlockActual が指す値は、すべての情報を格納するために必要なバッファーのサイズを示します。バッファーを必要なサイズまで拡大し、関数を再度呼び出してください。

その他の種類の失敗の場合、戻り値は システムエラーコードです。

解説(Remarks)

パフォーマンスカウンター値に関する情報は、pCounterBlock で指定したバッファーに PERF_DATA_HEADER ブロックとして書き込まれます。これは PERF_DATA_HEADER 構造体の後に一連の PERF_COUNTER_HEADER ブロックが続く形式です。

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

各言語での呼び出し定義

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

DWORD PerfQueryCounterData(
    HANDLE hQuery,
    PERF_DATA_HEADER* pCounterBlock,   // optional
    DWORD cbCounterBlock,
    DWORD* pcbCounterBlockActual
);
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern uint PerfQueryCounterData(
    IntPtr hQuery,   // HANDLE
    IntPtr pCounterBlock,   // PERF_DATA_HEADER* optional, out
    uint cbCounterBlock,   // DWORD
    out uint pcbCounterBlockActual   // DWORD* out
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function PerfQueryCounterData(
    hQuery As IntPtr,   ' HANDLE
    pCounterBlock As IntPtr,   ' PERF_DATA_HEADER* optional, out
    cbCounterBlock As UInteger,   ' DWORD
    <Out> ByRef pcbCounterBlockActual As UInteger   ' DWORD* out
) As UInteger
End Function
' hQuery : HANDLE
' pCounterBlock : PERF_DATA_HEADER* optional, out
' cbCounterBlock : DWORD
' pcbCounterBlockActual : DWORD* out
Declare PtrSafe Function PerfQueryCounterData Lib "advapi32" ( _
    ByVal hQuery As LongPtr, _
    ByVal pCounterBlock As LongPtr, _
    ByVal cbCounterBlock As Long, _
    ByRef pcbCounterBlockActual As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PerfQueryCounterData = ctypes.windll.advapi32.PerfQueryCounterData
PerfQueryCounterData.restype = wintypes.DWORD
PerfQueryCounterData.argtypes = [
    wintypes.HANDLE,  # hQuery : HANDLE
    ctypes.c_void_p,  # pCounterBlock : PERF_DATA_HEADER* optional, out
    wintypes.DWORD,  # cbCounterBlock : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbCounterBlockActual : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procPerfQueryCounterData = advapi32.NewProc("PerfQueryCounterData")
)

// hQuery (HANDLE), pCounterBlock (PERF_DATA_HEADER* optional, out), cbCounterBlock (DWORD), pcbCounterBlockActual (DWORD* out)
r1, _, err := procPerfQueryCounterData.Call(
	uintptr(hQuery),
	uintptr(pCounterBlock),
	uintptr(cbCounterBlock),
	uintptr(pcbCounterBlockActual),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PerfQueryCounterData(
  hQuery: THandle;   // HANDLE
  pCounterBlock: Pointer;   // PERF_DATA_HEADER* optional, out
  cbCounterBlock: DWORD;   // DWORD
  pcbCounterBlockActual: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'PerfQueryCounterData';
result := DllCall("ADVAPI32\PerfQueryCounterData"
    , "Ptr", hQuery   ; HANDLE
    , "Ptr", pCounterBlock   ; PERF_DATA_HEADER* optional, out
    , "UInt", cbCounterBlock   ; DWORD
    , "Ptr", pcbCounterBlockActual   ; DWORD* out
    , "UInt")   ; return: DWORD
●PerfQueryCounterData(hQuery, pCounterBlock, cbCounterBlock, pcbCounterBlockActual) = DLL("ADVAPI32.dll", "dword PerfQueryCounterData(void*, void*, dword, void*)")
# 呼び出し: PerfQueryCounterData(hQuery, pCounterBlock, cbCounterBlock, pcbCounterBlockActual)
# hQuery : HANDLE -> "void*"
# pCounterBlock : PERF_DATA_HEADER* optional, out -> "void*"
# cbCounterBlock : DWORD -> "dword"
# pcbCounterBlockActual : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef PerfQueryCounterDataNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef PerfQueryCounterDataDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Uint32>);
final PerfQueryCounterData = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<PerfQueryCounterDataNative, PerfQueryCounterDataDart>('PerfQueryCounterData');
// hQuery : HANDLE -> Pointer<Void>
// pCounterBlock : PERF_DATA_HEADER* optional, out -> Pointer<Void>
// cbCounterBlock : DWORD -> Uint32
// pcbCounterBlockActual : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PerfQueryCounterData(
  hQuery: THandle;   // HANDLE
  pCounterBlock: Pointer;   // PERF_DATA_HEADER* optional, out
  cbCounterBlock: DWORD;   // DWORD
  pcbCounterBlockActual: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'PerfQueryCounterData';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PerfQueryCounterData"
  c_PerfQueryCounterData :: Ptr () -> Ptr () -> Word32 -> Ptr Word32 -> IO Word32
-- hQuery : HANDLE -> Ptr ()
-- pCounterBlock : PERF_DATA_HEADER* optional, out -> Ptr ()
-- cbCounterBlock : DWORD -> Word32
-- pcbCounterBlockActual : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let perfquerycounterdata =
  foreign "PerfQueryCounterData"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* hQuery : HANDLE -> (ptr void) *)
(* pCounterBlock : PERF_DATA_HEADER* optional, out -> (ptr void) *)
(* cbCounterBlock : DWORD -> uint32_t *)
(* pcbCounterBlockActual : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("PerfQueryCounterData" perf-query-counter-data :convention :stdcall) :uint32
  (h-query :pointer)   ; HANDLE
  (p-counter-block :pointer)   ; PERF_DATA_HEADER* optional, out
  (cb-counter-block :uint32)   ; DWORD
  (pcb-counter-block-actual :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PerfQueryCounterData = Win32::API::More->new('ADVAPI32',
    'DWORD PerfQueryCounterData(HANDLE hQuery, LPVOID pCounterBlock, DWORD cbCounterBlock, LPVOID pcbCounterBlockActual)');
# my $ret = $PerfQueryCounterData->Call($hQuery, $pCounterBlock, $cbCounterBlock, $pcbCounterBlockActual);
# hQuery : HANDLE -> HANDLE
# pCounterBlock : PERF_DATA_HEADER* optional, out -> LPVOID
# cbCounterBlock : DWORD -> DWORD
# pcbCounterBlockActual : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型