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

PdhCollectQueryDataEx

関数
指定間隔で非同期にカウンターデータを収集する。
DLLpdh.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD PdhCollectQueryDataEx(
    PDH_HQUERY hQuery,
    DWORD dwIntervalTime,
    HANDLE hNewDataEvent
);

パラメーター

名前方向説明
hQueryPDH_HQUERYinクエリのハンドル。クエリは、収集対象とするカウンターを識別します。このハンドルは PdhOpenQuery 関数から返されます。
dwIntervalTimeDWORDin待機する時間間隔(秒単位)。
hNewDataEventHANDLEin時間間隔が経過した後に PDH にシグナル状態にさせたいイベントのハンドル。イベントオブジェクトを作成するには、 CreateEvent 関数を呼び出します。

戻り値の型: DWORD

公式ドキュメント

別のスレッドを使用して、指定したクエリ内のすべてのカウンターについて現在の生データ値を収集します。その後、この関数はアプリケーション定義のイベントをシグナル状態にし、指定した時間間隔だけ待機してから戻ります。

戻り値

関数が成功した場合は、ERROR_SUCCESS を返します。

関数が失敗した場合、戻り値は システムエラーコード または PDH エラーコード です。次の値が考えられます。

戻り値 説明
PDH_INVALID_HANDLE
クエリハンドルが無効です。
PDH_NO_DATA
クエリに現在カウンターが 1 つもありません。

解説(Remarks)

PDH は、PdhCloseQuery 関数を呼び出すとスレッドを終了します。PdhCollectQueryDataEx を複数回呼び出した場合、後続の各呼び出しは前回の呼び出しで作成したスレッドを終了し、新しいスレッドを開始します。

PdhCollectQueryDataEx を 1 つのカウンターインスタンスのみのデータに対して呼び出し、そのカウンターインスタンスが存在しない場合、関数は PDH_NO_DATA を返します。ただし、複数のカウンターのデータを照会した場合は、カウンターインスタンスの 1 つがまだ存在しなくても PdhCollectQueryDataExERROR_SUCCESS を返すことがあります。これは、指定したカウンターインスタンスが存在しないのか、存在することになるがまだ作成されていないだけなのかを判断できないためです。この場合は、対象とする各カウンターインスタンスについて PdhGetRawCounterValue または PdhGetFormattedCounterValue を呼び出して、それらが存在するかどうかを判断してください。

PDH は、現在の収集と前回の収集の生カウンター値を格納します。現在の生カウンター値を取得するには、PdhGetRawCounterValue 関数を呼び出します。カウンター値の表示可能な値を計算するには、PdhGetFormattedCounterValue を呼び出します。カウンターパスにインスタンス名のワイルドカードが含まれている場合は、代わりにそれぞれ PdhGetRawCounterArray 関数および PdhGetFormattedCounterArray 関数を呼び出します。

次の例は、この関数の使用方法を示しています。


#include <windows.h>
#include <stdio.h>
#include <stdlib.h>
#include <pdh.h>

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

CONST PWSTR COUNTER_NAME    = L"\\Processor(0)\\% Processor Time";
CONST ULONG SAMPLE_COUNT    = 10;
CONST ULONG SAMPLE_INTERVAL = 2;

void wmain(void)
{
    PDH_STATUS Status;
    HANDLE Event = NULL;
    PDH_HQUERY Query = NULL;
    PDH_HCOUNTER Counter;
    ULONG WaitResult;
    ULONG CounterType;
    PDH_FMT_COUNTERVALUE DisplayValue;

    Status = PdhOpenQuery(NULL, 0, &Query);
    if (Status != ERROR_SUCCESS) 
    {
        wprintf(L"\nPdhOpenQuery failed with status 0x%x.", Status);
        goto Cleanup;
    }

    Status = PdhAddCounter(Query, COUNTER_NAME, 0, &Counter);
    if (Status != ERROR_SUCCESS) 
    {
        wprintf(L"\nPdhAddCounter failed with 0x%x.", Status);
        goto Cleanup;
    }

    //
    // Calculating the formatted value of some counters requires access to the
    // value of a previous sample. Make this call to get the first sample value
    // populated, to be used later for calculating the next sample.
    //

    Status = PdhCollectQueryData(Query);
    if (Status != ERROR_SUCCESS) 
    {
        wprintf(L"\nPdhCollectQueryData failed with status 0x%x.", Status);
        goto Cleanup;
    }

    //
    // This will create a separate thread that will collect raw counter data
    // every 2 seconds and set the supplied Event.
    //

    Event = CreateEvent(NULL, FALSE, FALSE, L"MyEvent");
    if (Event == NULL) 
    {
        wprintf(L"\nCreateEvent failed with status 0x%x.", GetLastError());
        goto Cleanup;
    }

    Status = PdhCollectQueryDataEx(Query, SAMPLE_INTERVAL, Event);
    if (Status != ERROR_SUCCESS) 
    {
        wprintf(L"\nPdhCollectQueryDataEx failed with status 0x%x.", Status);
        goto Cleanup;
    }

    //
    // Collect and format 10 samples, 2 seconds apart.
    //

    for (ULONG i = 0; i < SAMPLE_COUNT; i++) 
    {
        WaitResult = WaitForSingleObject(Event, INFINITE);

        if (WaitResult == WAIT_OBJECT_0) 
        {
            Status = PdhGetFormattedCounterValue(Counter, PDH_FMT_DOUBLE, &CounterType, &DisplayValue);

            if (Status == ERROR_SUCCESS) 
            {
                wprintf(L"\nCounter Value: %.20g", DisplayValue.doubleValue);
            } 
            else 
            {
                wprintf(L"\nPdhGetFormattedCounterValue failed with status 0x%x.", Status);
                goto Cleanup;
            }
        } 
        else if (WaitResult == WAIT_FAILED) 
        {
            wprintf(L"\nWaitForSingleObject failed with status 0x%x.", GetLastError());
            goto Cleanup;
        }
    }

Cleanup:

    if (Event) 
    {
        CloseHandle(Event);
    }

    //
    // This will close both the Query handle and all associated Counter handles
    // returned by PdhAddCounter.
    //

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

各言語での呼び出し定義

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

DWORD PdhCollectQueryDataEx(
    PDH_HQUERY hQuery,
    DWORD dwIntervalTime,
    HANDLE hNewDataEvent
);
[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhCollectQueryDataEx(
    IntPtr hQuery,   // PDH_HQUERY
    uint dwIntervalTime,   // DWORD
    IntPtr hNewDataEvent   // HANDLE
);
<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhCollectQueryDataEx(
    hQuery As IntPtr,   ' PDH_HQUERY
    dwIntervalTime As UInteger,   ' DWORD
    hNewDataEvent As IntPtr   ' HANDLE
) As UInteger
End Function
' hQuery : PDH_HQUERY
' dwIntervalTime : DWORD
' hNewDataEvent : HANDLE
Declare PtrSafe Function PdhCollectQueryDataEx Lib "pdh" ( _
    ByVal hQuery As LongPtr, _
    ByVal dwIntervalTime As Long, _
    ByVal hNewDataEvent As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PdhCollectQueryDataEx = ctypes.windll.pdh.PdhCollectQueryDataEx
PdhCollectQueryDataEx.restype = wintypes.DWORD
PdhCollectQueryDataEx.argtypes = [
    wintypes.HANDLE,  # hQuery : PDH_HQUERY
    wintypes.DWORD,  # dwIntervalTime : DWORD
    wintypes.HANDLE,  # hNewDataEvent : HANDLE
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhCollectQueryDataEx = Fiddle::Function.new(
  lib['PdhCollectQueryDataEx'],
  [
    Fiddle::TYPE_VOIDP,  # hQuery : PDH_HQUERY
    -Fiddle::TYPE_INT,  # dwIntervalTime : DWORD
    Fiddle::TYPE_VOIDP,  # hNewDataEvent : HANDLE
  ],
  -Fiddle::TYPE_INT)
#[link(name = "pdh")]
extern "system" {
    fn PdhCollectQueryDataEx(
        hQuery: *mut core::ffi::c_void,  // PDH_HQUERY
        dwIntervalTime: u32,  // DWORD
        hNewDataEvent: *mut core::ffi::c_void  // HANDLE
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("pdh.dll")]
public static extern uint PdhCollectQueryDataEx(IntPtr hQuery, uint dwIntervalTime, IntPtr hNewDataEvent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhCollectQueryDataEx' -Namespace Win32 -PassThru
# $api::PdhCollectQueryDataEx(hQuery, dwIntervalTime, hNewDataEvent)
#uselib "pdh.dll"
#func global PdhCollectQueryDataEx "PdhCollectQueryDataEx" sptr, sptr, sptr
; PdhCollectQueryDataEx hQuery, dwIntervalTime, hNewDataEvent   ; 戻り値は stat
; hQuery : PDH_HQUERY -> "sptr"
; dwIntervalTime : DWORD -> "sptr"
; hNewDataEvent : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "pdh.dll"
#cfunc global PdhCollectQueryDataEx "PdhCollectQueryDataEx" sptr, int, sptr
; res = PdhCollectQueryDataEx(hQuery, dwIntervalTime, hNewDataEvent)
; hQuery : PDH_HQUERY -> "sptr"
; dwIntervalTime : DWORD -> "int"
; hNewDataEvent : HANDLE -> "sptr"
; DWORD PdhCollectQueryDataEx(PDH_HQUERY hQuery, DWORD dwIntervalTime, HANDLE hNewDataEvent)
#uselib "pdh.dll"
#cfunc global PdhCollectQueryDataEx "PdhCollectQueryDataEx" intptr, int, intptr
; res = PdhCollectQueryDataEx(hQuery, dwIntervalTime, hNewDataEvent)
; hQuery : PDH_HQUERY -> "intptr"
; dwIntervalTime : DWORD -> "int"
; hNewDataEvent : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhCollectQueryDataEx = pdh.NewProc("PdhCollectQueryDataEx")
)

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

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

typedef PdhCollectQueryDataExNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef PdhCollectQueryDataExDart = int Function(Pointer<Void>, int, Pointer<Void>);
final PdhCollectQueryDataEx = DynamicLibrary.open('pdh.dll')
    .lookupFunction<PdhCollectQueryDataExNative, PdhCollectQueryDataExDart>('PdhCollectQueryDataEx');
// hQuery : PDH_HQUERY -> Pointer<Void>
// dwIntervalTime : DWORD -> Uint32
// hNewDataEvent : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PdhCollectQueryDataEx(
  hQuery: THandle;   // PDH_HQUERY
  dwIntervalTime: DWORD;   // DWORD
  hNewDataEvent: THandle   // HANDLE
): DWORD; stdcall;
  external 'pdh.dll' name 'PdhCollectQueryDataEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PdhCollectQueryDataEx"
  c_PdhCollectQueryDataEx :: Ptr () -> Word32 -> Ptr () -> IO Word32
-- hQuery : PDH_HQUERY -> Ptr ()
-- dwIntervalTime : DWORD -> Word32
-- hNewDataEvent : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let pdhcollectquerydataex =
  foreign "PdhCollectQueryDataEx"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hQuery : PDH_HQUERY -> (ptr void) *)
(* dwIntervalTime : DWORD -> uint32_t *)
(* hNewDataEvent : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library pdh (t "pdh.dll"))
(cffi:use-foreign-library pdh)

(cffi:defcfun ("PdhCollectQueryDataEx" pdh-collect-query-data-ex :convention :stdcall) :uint32
  (h-query :pointer)   ; PDH_HQUERY
  (dw-interval-time :uint32)   ; DWORD
  (h-new-data-event :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PdhCollectQueryDataEx = Win32::API::More->new('pdh',
    'DWORD PdhCollectQueryDataEx(HANDLE hQuery, DWORD dwIntervalTime, HANDLE hNewDataEvent)');
# my $ret = $PdhCollectQueryDataEx->Call($hQuery, $dwIntervalTime, $hNewDataEvent);
# hQuery : PDH_HQUERY -> HANDLE
# dwIntervalTime : DWORD -> DWORD
# hNewDataEvent : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目