ホーム › System.Performance › PdhGetDataSourceTimeRangeA

PdhGetDataSourceTimeRangeA

関数

データソースの時間範囲を取得する(ANSI版)。

DLLpdh.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// pdh.dll  (ANSI / -A)
#include <windows.h>

DWORD PdhGetDataSourceTimeRangeA(
    LPCSTR szDataSource,   // optional
    DWORD* pdwNumEntries,
    PDH_TIME_INFO* pInfo,
    DWORD* pdwBufferSize
);

パラメーター

名前	型	方向	説明
szDataSource	LPCSTR	inoptional	時間範囲情報の取得元となるログファイルの名前を指定する、null で終わる文字列です。
pdwNumEntries	DWORD*	out	pInfo バッファ内の構造体の数です。この関数は 1 つの時間範囲についてのみ情報を収集するため、通常は 1 になります。エラーが発生した場合は 0 になります。
pInfo	PDH_TIME_INFO*	out	時間範囲を受け取る PDH_TIME_INFO 構造体です。
pdwBufferSize	DWORD*	inout	PDH_TIME_INFO 構造体のサイズ(バイト単位)です。

戻り値の型: DWORD

公式ドキュメント

指定された入力ソースのパフォーマンスデータについて、時間範囲、エントリ数、および該当する場合はそのデータを格納するバッファのサイズを取得します。データソースのハンドルを使用するには、PdhGetDataSourceTimeRangeH 関数を使用します。(ANSI)

戻り値

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

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

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

解説(Remarks)

メモ

pdh.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PdhGetDataSourceTimeRange を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// pdh.dll  (ANSI / -A)
#include <windows.h>

DWORD PdhGetDataSourceTimeRangeA(
    LPCSTR szDataSource,   // optional
    DWORD* pdwNumEntries,
    PDH_TIME_INFO* pInfo,
    DWORD* pdwBufferSize
);

[DllImport("pdh.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PdhGetDataSourceTimeRangeA(
    [MarshalAs(UnmanagedType.LPStr)] string szDataSource,   // LPCSTR optional
    out uint pdwNumEntries,   // DWORD* out
    IntPtr pInfo,   // PDH_TIME_INFO* out
    ref uint pdwBufferSize   // DWORD* in/out
);

<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhGetDataSourceTimeRangeA(
    <MarshalAs(UnmanagedType.LPStr)> szDataSource As String,   ' LPCSTR optional
    <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

' szDataSource : LPCSTR optional
' pdwNumEntries : DWORD* out
' pInfo : PDH_TIME_INFO* out
' pdwBufferSize : DWORD* in/out
Declare PtrSafe Function PdhGetDataSourceTimeRangeA Lib "pdh" ( _
    ByVal szDataSource As String, _
    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

PdhGetDataSourceTimeRangeA = ctypes.windll.pdh.PdhGetDataSourceTimeRangeA
PdhGetDataSourceTimeRangeA.restype = wintypes.DWORD
PdhGetDataSourceTimeRangeA.argtypes = [
    wintypes.LPCSTR,  # szDataSource : LPCSTR optional
    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')
PdhGetDataSourceTimeRangeA = Fiddle::Function.new(
  lib['PdhGetDataSourceTimeRangeA'],
  [
    Fiddle::TYPE_VOIDP,  # szDataSource : LPCSTR optional
    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 PdhGetDataSourceTimeRangeA(
        szDataSource: *const u8,  // LPCSTR optional
        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", CharSet = CharSet.Ansi)]
public static extern uint PdhGetDataSourceTimeRangeA([MarshalAs(UnmanagedType.LPStr)] string szDataSource, out uint pdwNumEntries, IntPtr pInfo, ref uint pdwBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhGetDataSourceTimeRangeA' -Namespace Win32 -PassThru
# $api::PdhGetDataSourceTimeRangeA(szDataSource, pdwNumEntries, pInfo, pdwBufferSize)

#uselib "pdh.dll"
#func global PdhGetDataSourceTimeRangeA "PdhGetDataSourceTimeRangeA" sptr, sptr, sptr, sptr
; PdhGetDataSourceTimeRangeA szDataSource, varptr(pdwNumEntries), varptr(pInfo), varptr(pdwBufferSize)   ; 戻り値は stat
; szDataSource : LPCSTR optional -> "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 PdhGetDataSourceTimeRangeA "PdhGetDataSourceTimeRangeA" str, var, var, var
; res = PdhGetDataSourceTimeRangeA(szDataSource, pdwNumEntries, pInfo, pdwBufferSize)
; szDataSource : LPCSTR optional -> "str"
; pdwNumEntries : DWORD* out -> "var"
; pInfo : PDH_TIME_INFO* out -> "var"
; pdwBufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "pdh.dll"
#cfunc global PdhGetDataSourceTimeRangeA "PdhGetDataSourceTimeRangeA" str, sptr, sptr, sptr
; res = PdhGetDataSourceTimeRangeA(szDataSource, varptr(pdwNumEntries), varptr(pInfo), varptr(pdwBufferSize))
; szDataSource : LPCSTR optional -> "str"
; pdwNumEntries : DWORD* out -> "sptr"
; pInfo : PDH_TIME_INFO* out -> "sptr"
; pdwBufferSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。