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

PdhCollectQueryData

関数
照会に追加された全カウンターの現在データを収集する。
DLLpdh.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD PdhCollectQueryData(
    PDH_HQUERY hQuery
);

パラメーター

名前方向説明
hQueryPDH_HQUERYinoutデータを収集するクエリのハンドル。このハンドルは PdhOpenQuery 関数が返します。

戻り値の型: DWORD

公式ドキュメント

指定したクエリ内のすべてのカウンターについて、現在の生データ値を収集し、各カウンターのステータスコードを更新します。(PdhCollectQueryData)

戻り値

関数が成功した場合は ERROR_SUCCESS を返します。それ以外の場合は、 システムエラーコード または PDH エラーコード を返します。

指定できる値は次のとおりです。

戻り値 説明
PDH_INVALID_HANDLE
クエリハンドルが無効です。
PDH_NO_DATA
クエリには現在カウンターが 1 つも含まれていません。ユーザーが昇格されたトークンで実行していない場合、クエリにデータが含まれないことがあります(Limited User Access Support を参照してください)。

解説(Remarks)

クエリ内のカウンターについてカウンターデータを収集したいときに、この関数を呼び出します。PDH は現在および前回の収集分の生のカウンター値を保持します。

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

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

Visual Basic からこの関数を呼び出す場合の構文を次に示します。

PdhCollectQueryData(
  ByVal QueryHandle as Long  
)
as Long

例については、 Browsing Performance Counters または Reading Performance Data from a Log File を参照してください。

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

各言語での呼び出し定義

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

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

PdhCollectQueryData = ctypes.windll.pdh.PdhCollectQueryData
PdhCollectQueryData.restype = wintypes.DWORD
PdhCollectQueryData.argtypes = [
    wintypes.HANDLE,  # hQuery : PDH_HQUERY in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	pdh = windows.NewLazySystemDLL("pdh.dll")
	procPdhCollectQueryData = pdh.NewProc("PdhCollectQueryData")
)

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

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

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

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

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

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

関連項目

類似 API
公式の関連項目