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

PerfQueryCounterInfo

関数
照会に追加されたカウンターの情報を取得する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

DWORD PerfQueryCounterInfo(
    HANDLE hQuery,
    PERF_COUNTER_IDENTIFIER* pCounters,   // optional
    DWORD cbCounters,
    DWORD* pcbCountersActual
);

パラメーター

名前方向説明
hQueryHANDLEinカウンター仕様を取得する対象のクエリへのハンドル。
pCountersPERF_COUNTER_IDENTIFIER*outoptionalcbCounters パラメーターで指定したサイズ(バイト単位)のデータを格納できる十分な大きさのバッファーへのポインター。cbCounters が 0 の場合は NULL でもかまいません。
cbCountersDWORDinpCounters バッファーのサイズ(バイト単位)。
pcbCountersActualDWORD*out

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

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

戻り値の型: DWORD

公式ドキュメント

指定したクエリ内のカウンター仕様を取得します。

戻り値

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

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

解説(Remarks)

カウンター仕様に関する情報は、PERF_COUNTER_IDENTIFIER ブロックのシーケンスとして、pCounters で指定されたバッファーに書き込まれます。ブロックのシーケンスのサイズ(バイト単位)は pcbCountersActual に書き込まれます。各 PERF_COUNTER_IDENTIFIER ブロックは、PERF_COUNTER_IDENTIFIER 構造体と、それに続く(省略可能な)null 終端の UTF-16LE インスタンス名、さらに PERF_COUNTER_IDENTIFIER ブロックのサイズが 8 バイトの倍数になるようにするためのパディングで構成されます。PERF_COUNTER_IDENTIFIER 構造体、インスタンス名、パディングを含む各ブロックのサイズは、PERF_COUNTER_IDENTIFIER 構造体の Size メンバーによって決定され、8 バイトの倍数になります。

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

各言語での呼び出し定義

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

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

PerfQueryCounterInfo = ctypes.windll.advapi32.PerfQueryCounterInfo
PerfQueryCounterInfo.restype = wintypes.DWORD
PerfQueryCounterInfo.argtypes = [
    wintypes.HANDLE,  # hQuery : HANDLE
    ctypes.c_void_p,  # pCounters : PERF_COUNTER_IDENTIFIER* optional, out
    wintypes.DWORD,  # cbCounters : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbCountersActual : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procPerfQueryCounterInfo = advapi32.NewProc("PerfQueryCounterInfo")
)

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

extern "advapi32" fn PerfQueryCounterInfo(
    hQuery: ?*anyopaque, // HANDLE
    pCounters: [*c]PERF_COUNTER_IDENTIFIER, // PERF_COUNTER_IDENTIFIER* optional, out
    cbCounters: u32, // DWORD
    pcbCountersActual: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
proc PerfQueryCounterInfo(
    hQuery: pointer,  # HANDLE
    pCounters: ptr PERF_COUNTER_IDENTIFIER,  # PERF_COUNTER_IDENTIFIER* optional, out
    cbCounters: uint32,  # DWORD
    pcbCountersActual: ptr uint32  # DWORD* out
): uint32 {.importc: "PerfQueryCounterInfo", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
uint PerfQueryCounterInfo(
    void* hQuery,   // HANDLE
    PERF_COUNTER_IDENTIFIER* pCounters,   // PERF_COUNTER_IDENTIFIER* optional, out
    uint cbCounters,   // DWORD
    uint* pcbCountersActual   // DWORD* out
);
ccall((:PerfQueryCounterInfo, "ADVAPI32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{PERF_COUNTER_IDENTIFIER}, UInt32, Ptr{UInt32}),
      hQuery, pCounters, cbCounters, pcbCountersActual)
# hQuery : HANDLE -> Ptr{Cvoid}
# pCounters : PERF_COUNTER_IDENTIFIER* optional, out -> Ptr{PERF_COUNTER_IDENTIFIER}
# cbCounters : DWORD -> UInt32
# pcbCountersActual : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PerfQueryCounterInfo(
    void* hQuery,
    void* pCounters,
    uint32_t cbCounters,
    uint32_t* pcbCountersActual);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.PerfQueryCounterInfo(hQuery, pCounters, cbCounters, pcbCountersActual)
-- hQuery : HANDLE
-- pCounters : PERF_COUNTER_IDENTIFIER* optional, out
-- cbCounters : DWORD
-- pcbCountersActual : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const PerfQueryCounterInfo = lib.func('__stdcall', 'PerfQueryCounterInfo', 'uint32_t', ['void *', 'void *', 'uint32_t', 'uint32_t *']);
// PerfQueryCounterInfo(hQuery, pCounters, cbCounters, pcbCountersActual)
// hQuery : HANDLE -> 'void *'
// pCounters : PERF_COUNTER_IDENTIFIER* optional, out -> 'void *'
// cbCounters : DWORD -> 'uint32_t'
// pcbCountersActual : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  PerfQueryCounterInfo: { parameters: ["pointer", "pointer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.PerfQueryCounterInfo(hQuery, pCounters, cbCounters, pcbCountersActual)
// hQuery : HANDLE -> "pointer"
// pCounters : PERF_COUNTER_IDENTIFIER* optional, out -> "pointer"
// cbCounters : DWORD -> "u32"
// pcbCountersActual : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PerfQueryCounterInfo(
    void* hQuery,
    void* pCounters,
    uint32_t cbCounters,
    uint32_t* pcbCountersActual);
C, "ADVAPI32.dll");
// $ffi->PerfQueryCounterInfo(hQuery, pCounters, cbCounters, pcbCountersActual);
// hQuery : HANDLE
// pCounters : PERF_COUNTER_IDENTIFIER* optional, out
// cbCounters : DWORD
// pcbCountersActual : 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 PerfQueryCounterInfo(
        Pointer hQuery,   // HANDLE
        Pointer pCounters,   // PERF_COUNTER_IDENTIFIER* optional, out
        int cbCounters,   // DWORD
        IntByReference pcbCountersActual   // DWORD* out
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun PerfQueryCounterInfo = PerfQueryCounterInfo(
    hQuery : Void*,   # HANDLE
    pCounters : PERF_COUNTER_IDENTIFIER*,   # PERF_COUNTER_IDENTIFIER* optional, out
    cbCounters : UInt32,   # DWORD
    pcbCountersActual : 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 PerfQueryCounterInfoNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef PerfQueryCounterInfoDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Uint32>);
final PerfQueryCounterInfo = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<PerfQueryCounterInfoNative, PerfQueryCounterInfoDart>('PerfQueryCounterInfo');
// hQuery : HANDLE -> Pointer<Void>
// pCounters : PERF_COUNTER_IDENTIFIER* optional, out -> Pointer<Void>
// cbCounters : DWORD -> Uint32
// pcbCountersActual : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PerfQueryCounterInfo(
  hQuery: THandle;   // HANDLE
  pCounters: Pointer;   // PERF_COUNTER_IDENTIFIER* optional, out
  cbCounters: DWORD;   // DWORD
  pcbCountersActual: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'PerfQueryCounterInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let perfquerycounterinfo =
  foreign "PerfQueryCounterInfo"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* hQuery : HANDLE -> (ptr void) *)
(* pCounters : PERF_COUNTER_IDENTIFIER* optional, out -> (ptr void) *)
(* cbCounters : DWORD -> uint32_t *)
(* pcbCountersActual : 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 ("PerfQueryCounterInfo" perf-query-counter-info :convention :stdcall) :uint32
  (h-query :pointer)   ; HANDLE
  (p-counters :pointer)   ; PERF_COUNTER_IDENTIFIER* optional, out
  (cb-counters :uint32)   ; DWORD
  (pcb-counters-actual :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PerfQueryCounterInfo = Win32::API::More->new('ADVAPI32',
    'DWORD PerfQueryCounterInfo(HANDLE hQuery, LPVOID pCounters, DWORD cbCounters, LPVOID pcbCountersActual)');
# my $ret = $PerfQueryCounterInfo->Call($hQuery, $pCounters, $cbCounters, $pcbCountersActual);
# hQuery : HANDLE -> HANDLE
# pCounters : PERF_COUNTER_IDENTIFIER* optional, out -> LPVOID
# cbCounters : DWORD -> DWORD
# pcbCountersActual : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型