ホーム › System.Performance › PdhCollectQueryDataWithTime

PdhCollectQueryDataWithTime

関数

照会データを収集しタイムスタンプも取得する。

DLLpdh.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD PdhCollectQueryDataWithTime(
    PDH_HQUERY hQuery,
    LONGLONG* pllTimeStamp
);

パラメーター

名前	型	方向	説明
hQuery	PDH_HQUERY	inout	データを収集する対象のクエリのハンドル。このハンドルは PdhOpenQuery 関数によって返されます。
pllTimeStamp	LONGLONG*	out	クエリ内の最初のカウンター値が取得された時刻のタイムスタンプ。時刻は FILETIME として指定されます。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功した場合は ERROR_SUCCESS を返します。そうでない場合は、システムエラーコードまたは PDH エラーコードを返します。

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

戻り値	説明
PDH_INVALID_HANDLE	クエリハンドルが無効です。
PDH_NO_DATA	クエリに現在カウンターが含まれていません。

解説(Remarks)

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

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

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

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

各言語での呼び出し定義

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

DWORD PdhCollectQueryDataWithTime(
    PDH_HQUERY hQuery,
    LONGLONG* pllTimeStamp
);

[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhCollectQueryDataWithTime(
    IntPtr hQuery,   // PDH_HQUERY in/out
    out long pllTimeStamp   // LONGLONG* out
);

<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhCollectQueryDataWithTime(
    hQuery As IntPtr,   ' PDH_HQUERY in/out
    <Out> ByRef pllTimeStamp As Long   ' LONGLONG* out
) As UInteger
End Function

' hQuery : PDH_HQUERY in/out
' pllTimeStamp : LONGLONG* out
Declare PtrSafe Function PdhCollectQueryDataWithTime Lib "pdh" ( _
    ByVal hQuery As LongPtr, _
    ByRef pllTimeStamp As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhCollectQueryDataWithTime = ctypes.windll.pdh.PdhCollectQueryDataWithTime
PdhCollectQueryDataWithTime.restype = wintypes.DWORD
PdhCollectQueryDataWithTime.argtypes = [
    wintypes.HANDLE,  # hQuery : PDH_HQUERY in/out
    ctypes.POINTER(ctypes.c_longlong),  # pllTimeStamp : LONGLONG* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhCollectQueryDataWithTime = Fiddle::Function.new(
  lib['PdhCollectQueryDataWithTime'],
  [
    Fiddle::TYPE_VOIDP,  # hQuery : PDH_HQUERY in/out
    Fiddle::TYPE_VOIDP,  # pllTimeStamp : LONGLONG* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhCollectQueryDataWithTime(
        hQuery: *mut core::ffi::c_void,  // PDH_HQUERY in/out
        pllTimeStamp: *mut i64  // LONGLONG* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll")]
public static extern uint PdhCollectQueryDataWithTime(IntPtr hQuery, out long pllTimeStamp);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhCollectQueryDataWithTime' -Namespace Win32 -PassThru
# $api::PdhCollectQueryDataWithTime(hQuery, pllTimeStamp)

#uselib "pdh.dll"
#func global PdhCollectQueryDataWithTime "PdhCollectQueryDataWithTime" sptr, sptr
; PdhCollectQueryDataWithTime hQuery, varptr(pllTimeStamp)   ; 戻り値は stat
; hQuery : PDH_HQUERY in/out -> "sptr"
; pllTimeStamp : LONGLONG* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "pdh.dll"
#cfunc global PdhCollectQueryDataWithTime "PdhCollectQueryDataWithTime" sptr, var
; res = PdhCollectQueryDataWithTime(hQuery, pllTimeStamp)
; hQuery : PDH_HQUERY in/out -> "sptr"
; pllTimeStamp : LONGLONG* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "pdh.dll"
#cfunc global PdhCollectQueryDataWithTime "PdhCollectQueryDataWithTime" sptr, sptr
; res = PdhCollectQueryDataWithTime(hQuery, varptr(pllTimeStamp))
; hQuery : PDH_HQUERY in/out -> "sptr"
; pllTimeStamp : LONGLONG* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。