ホーム › System.Performance › PdhGetDataSourceTimeRangeH

PdhGetDataSourceTimeRangeH

関数

データソースハンドルから時間範囲を取得する。

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

シグネチャ

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

DWORD PdhGetDataSourceTimeRangeH(
    PDH_HLOG hDataSource,   // optional
    DWORD* pdwNumEntries,
    PDH_TIME_INFO* pInfo,
    DWORD* pdwBufferSize
);

パラメーター

名前	型	方向	説明
hDataSource	PDH_HLOG	inoutoptional	PdhBindInputDataSource 関数によって返されたデータソースへのハンドルです。
pdwNumEntries	DWORD*	out	pInfo バッファ内の構造体の数です。この関数は 1 つの時間範囲についてのみ情報を収集するため、値は通常 1 になります。エラーが発生した場合は 0 になります。
pInfo	PDH_TIME_INFO*	out	時間範囲を受け取る PDH_TIME_INFO 構造体です。この情報は、バインドされたすべてのログファイルにまたがります。
pdwBufferSize	DWORD*	inout	PDH_TIME_INFO 構造体のサイズ(バイト単位)です。

戻り値の型: DWORD

公式ドキュメント

指定された入力ソースのパフォーマンスデータを格納するバッファについて、時間範囲、エントリ数、および該当する場合はサイズを取得します。この関数は、データソースへのハンドルの使用をサポートする点を除き、PdhGetDataSourceTimeRange 関数と同一です。

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードまたは PDH エラーコードです。以下は想定される値です。

戻り値	説明
PDH_INVALID_ARGUMENT	パラメーターが無効であるか、形式が正しくありません。
PDH_INVALID_HANDLE	カウンターハンドルが無効です。
PDH_DATA_SOURCE_IS_REAL_TIME	現在のデータソースはリアルタイムデータソースです。

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

各言語での呼び出し定義

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

DWORD PdhGetDataSourceTimeRangeH(
    PDH_HLOG hDataSource,   // optional
    DWORD* pdwNumEntries,
    PDH_TIME_INFO* pInfo,
    DWORD* pdwBufferSize
);

[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhGetDataSourceTimeRangeH(
    IntPtr hDataSource,   // PDH_HLOG optional, in/out
    out uint pdwNumEntries,   // DWORD* out
    IntPtr pInfo,   // PDH_TIME_INFO* out
    ref uint pdwBufferSize   // DWORD* in/out
);

<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhGetDataSourceTimeRangeH(
    hDataSource As IntPtr,   ' PDH_HLOG optional, in/out
    <Out> ByRef pdwNumEntries As UInteger,   ' DWORD* out
    pInfo As IntPtr,   ' PDH_TIME_INFO* out
    ByRef pdwBufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function

' hDataSource : PDH_HLOG optional, in/out
' pdwNumEntries : DWORD* out
' pInfo : PDH_TIME_INFO* out
' pdwBufferSize : DWORD* in/out
Declare PtrSafe Function PdhGetDataSourceTimeRangeH Lib "pdh" ( _
    ByVal hDataSource As LongPtr, _
    ByRef pdwNumEntries As Long, _
    ByVal pInfo As LongPtr, _
    ByRef pdwBufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhGetDataSourceTimeRangeH = ctypes.windll.pdh.PdhGetDataSourceTimeRangeH
PdhGetDataSourceTimeRangeH.restype = wintypes.DWORD
PdhGetDataSourceTimeRangeH.argtypes = [
    wintypes.HANDLE,  # hDataSource : PDH_HLOG optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # pdwNumEntries : DWORD* out
    ctypes.c_void_p,  # pInfo : PDH_TIME_INFO* out
    ctypes.POINTER(wintypes.DWORD),  # pdwBufferSize : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhGetDataSourceTimeRangeH = Fiddle::Function.new(
  lib['PdhGetDataSourceTimeRangeH'],
  [
    Fiddle::TYPE_VOIDP,  # hDataSource : PDH_HLOG optional, in/out
    Fiddle::TYPE_VOIDP,  # pdwNumEntries : DWORD* out
    Fiddle::TYPE_VOIDP,  # pInfo : PDH_TIME_INFO* out
    Fiddle::TYPE_VOIDP,  # pdwBufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhGetDataSourceTimeRangeH(
        hDataSource: *mut core::ffi::c_void,  // PDH_HLOG optional, in/out
        pdwNumEntries: *mut u32,  // DWORD* out
        pInfo: *mut PDH_TIME_INFO,  // PDH_TIME_INFO* out
        pdwBufferSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll")]
public static extern uint PdhGetDataSourceTimeRangeH(IntPtr hDataSource, out uint pdwNumEntries, IntPtr pInfo, ref uint pdwBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhGetDataSourceTimeRangeH' -Namespace Win32 -PassThru
# $api::PdhGetDataSourceTimeRangeH(hDataSource, pdwNumEntries, pInfo, pdwBufferSize)

#uselib "pdh.dll"
#func global PdhGetDataSourceTimeRangeH "PdhGetDataSourceTimeRangeH" sptr, sptr, sptr, sptr
; PdhGetDataSourceTimeRangeH hDataSource, varptr(pdwNumEntries), varptr(pInfo), varptr(pdwBufferSize)   ; 戻り値は stat
; hDataSource : PDH_HLOG optional, in/out -> "sptr"
; pdwNumEntries : DWORD* out -> "sptr"
; pInfo : PDH_TIME_INFO* out -> "sptr"
; pdwBufferSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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