ホーム › System.Performance › PdhSetQueryTimeRange

PdhSetQueryTimeRange

関数

ログ照会の対象とする時間範囲を設定する。

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

シグネチャ

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

DWORD PdhSetQueryTimeRange(
    PDH_HQUERY hQuery,
    PDH_TIME_INFO* pInfo
);

パラメーター

名前	型	方向	説明
hQuery	PDH_HQUERY	in	クエリへのハンドル。 PdhOpenQuery 関数がこのハンドルを返します。
pInfo	PDH_TIME_INFO*	in	時間範囲を指定する PDH_TIME_INFO 構造体です。時刻はローカルファイル時刻として指定します。終了時刻は開始時刻より大きくなければなりません。すべてのレコードを読み取りたい場合は、開始時刻に 0、終了時刻に 64 ビットの最大値を指定できます。

戻り値の型: DWORD

公式ドキュメント

ログファイルから読み取れるサンプルを、指定した時間範囲内(両端を含む)のものに制限します。

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードまたは PDH エラーコードです。指定可能な値は次のとおりです。

戻り値	説明
PDH_INVALID_HANDLE	クエリハンドルが無効です。
PDH_INVALID_ARGUMENT	終了時間範囲の値は、開始時間範囲の値より大きくなければなりません。

解説(Remarks)

指定した時間範囲の終端、またはログファイルの終端に達すると、 PdhCollectQueryData 関数は PDH_NO_MORE_DATA を返します。

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

各言語での呼び出し定義

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

DWORD PdhSetQueryTimeRange(
    PDH_HQUERY hQuery,
    PDH_TIME_INFO* pInfo
);

[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhSetQueryTimeRange(
    IntPtr hQuery,   // PDH_HQUERY
    IntPtr pInfo   // PDH_TIME_INFO*
);

<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhSetQueryTimeRange(
    hQuery As IntPtr,   ' PDH_HQUERY
    pInfo As IntPtr   ' PDH_TIME_INFO*
) As UInteger
End Function

' hQuery : PDH_HQUERY
' pInfo : PDH_TIME_INFO*
Declare PtrSafe Function PdhSetQueryTimeRange Lib "pdh" ( _
    ByVal hQuery As LongPtr, _
    ByVal pInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhSetQueryTimeRange = ctypes.windll.pdh.PdhSetQueryTimeRange
PdhSetQueryTimeRange.restype = wintypes.DWORD
PdhSetQueryTimeRange.argtypes = [
    wintypes.HANDLE,  # hQuery : PDH_HQUERY
    ctypes.c_void_p,  # pInfo : PDH_TIME_INFO*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhSetQueryTimeRange = Fiddle::Function.new(
  lib['PdhSetQueryTimeRange'],
  [
    Fiddle::TYPE_VOIDP,  # hQuery : PDH_HQUERY
    Fiddle::TYPE_VOIDP,  # pInfo : PDH_TIME_INFO*
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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