ホーム › System.Performance › PdhReadRawLogRecord

PdhReadRawLogRecord

関数

ログファイルから生のログレコードを読み取る。

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

シグネチャ

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

DWORD PdhReadRawLogRecord(
    PDH_HLOG hLog,
    FILETIME ftRecord,
    PDH_RAW_LOG_RECORD* pRawLogRecord,   // optional
    DWORD* pdwBufferLength
);

パラメーター

名前	型	方向	説明
hLog	PDH_HLOG	in	ログファイルへのハンドル。 PdhOpenLog 関数または PdhBindInputDataSource 関数がこのハンドルを返します。
ftRecord	FILETIME	in	読み取るレコードのタイムスタンプ。タイムスタンプがログファイル内のレコードと一致しない場合、この関数は指定したタイムスタンプに最も近い(かつそれを超えない)タイムスタンプを持つレコードを返します。
pRawLogRecord	PDH_RAW_LOG_RECORD*	outoptional	呼び出し側が割り当てたバッファーで、 PDH_RAW_LOG_RECORD 構造体を受け取ります。この構造体にはログファイルのレコード情報が含まれます。pdwBufferLength がゼロの場合は NULL を設定します。
pdwBufferLength	DWORD*	inout	pRawLogRecord バッファーのサイズ(TCHAR 単位)。入力時にゼロの場合、この関数は PDH_MORE_DATA を返し、このパラメーターに必要なバッファーサイズを設定します。バッファーが必要なサイズより大きい場合、この関数はこのパラメーターに実際に使用されたバッファーのサイズを設定します。入力時に指定したサイズがゼロより大きく、かつ必要なサイズより小さい場合、返されたサイズをバッファーの再割り当てに使用しないでください。

戻り値の型: DWORD

公式ドキュメント

指定したバイナリトレースログファイル内の情報を読み取ります。

戻り値

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

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

戻り値	説明
PDH_INVALID_ARGUMENT	パラメーターが無効です。たとえば、一部のリリースでは、入力時に指定したサイズがゼロより大きく、かつ必要なサイズより小さい場合にこのエラーが返されることがあります。
PDH_MORE_DATA	pRawLogRecord バッファーがパス要素を格納するには小さすぎます。入力時に pdwBufferLength がゼロの場合、この戻り値が想定されます。入力時に指定したサイズがゼロより大きく、かつ必要なサイズより小さい場合、返されたサイズをバッファーの再割り当てに使用しないでください。
PDH_MEMORY_ALLOCATION_FAILURE	関数を完了するためのメモリを割り当てることができませんでした。

解説(Remarks)

この関数は 2 回呼び出す必要があります。1 回目は必要なバッファーサイズを取得するため(pRawLogRecord を NULL に、pdwBufferLength を 0 に設定)、2 回目はデータを取得するためです。

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

各言語での呼び出し定義

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

DWORD PdhReadRawLogRecord(
    PDH_HLOG hLog,
    FILETIME ftRecord,
    PDH_RAW_LOG_RECORD* pRawLogRecord,   // optional
    DWORD* pdwBufferLength
);

[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhReadRawLogRecord(
    IntPtr hLog,   // PDH_HLOG
    FILETIME ftRecord,   // FILETIME
    IntPtr pRawLogRecord,   // PDH_RAW_LOG_RECORD* optional, out
    ref uint pdwBufferLength   // DWORD* in/out
);

<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhReadRawLogRecord(
    hLog As IntPtr,   ' PDH_HLOG
    ftRecord As FILETIME,   ' FILETIME
    pRawLogRecord As IntPtr,   ' PDH_RAW_LOG_RECORD* optional, out
    ByRef pdwBufferLength As UInteger   ' DWORD* in/out
) As UInteger
End Function

' hLog : PDH_HLOG
' ftRecord : FILETIME
' pRawLogRecord : PDH_RAW_LOG_RECORD* optional, out
' pdwBufferLength : DWORD* in/out
Declare PtrSafe Function PdhReadRawLogRecord Lib "pdh" ( _
    ByVal hLog As LongPtr, _
    ByVal ftRecord As LongPtr, _
    ByVal pRawLogRecord As LongPtr, _
    ByRef pdwBufferLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhReadRawLogRecord = ctypes.windll.pdh.PdhReadRawLogRecord
PdhReadRawLogRecord.restype = wintypes.DWORD
PdhReadRawLogRecord.argtypes = [
    wintypes.HANDLE,  # hLog : PDH_HLOG
    FILETIME,  # ftRecord : FILETIME
    ctypes.c_void_p,  # pRawLogRecord : PDH_RAW_LOG_RECORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwBufferLength : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhReadRawLogRecord = Fiddle::Function.new(
  lib['PdhReadRawLogRecord'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : PDH_HLOG
    Fiddle::TYPE_VOIDP,  # ftRecord : FILETIME
    Fiddle::TYPE_VOIDP,  # pRawLogRecord : PDH_RAW_LOG_RECORD* optional, out
    Fiddle::TYPE_VOIDP,  # pdwBufferLength : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhReadRawLogRecord(
        hLog: *mut core::ffi::c_void,  // PDH_HLOG
        ftRecord: FILETIME,  // FILETIME
        pRawLogRecord: *mut PDH_RAW_LOG_RECORD,  // PDH_RAW_LOG_RECORD* optional, out
        pdwBufferLength: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll")]
public static extern uint PdhReadRawLogRecord(IntPtr hLog, FILETIME ftRecord, IntPtr pRawLogRecord, ref uint pdwBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhReadRawLogRecord' -Namespace Win32 -PassThru
# $api::PdhReadRawLogRecord(hLog, ftRecord, pRawLogRecord, pdwBufferLength)

#uselib "pdh.dll"
#func global PdhReadRawLogRecord "PdhReadRawLogRecord" sptr, sptr, sptr, sptr
; PdhReadRawLogRecord hLog, ftRecord, varptr(pRawLogRecord), varptr(pdwBufferLength)   ; 戻り値は stat
; hLog : PDH_HLOG -> "sptr"
; ftRecord : FILETIME -> "sptr"
; pRawLogRecord : PDH_RAW_LOG_RECORD* optional, out -> "sptr"
; pdwBufferLength : DWORD* in/out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "pdh.dll"
#cfunc global PdhReadRawLogRecord "PdhReadRawLogRecord" sptr, int, var, var
; res = PdhReadRawLogRecord(hLog, ftRecord, pRawLogRecord, pdwBufferLength)
; hLog : PDH_HLOG -> "sptr"
; ftRecord : FILETIME -> "int"
; pRawLogRecord : PDH_RAW_LOG_RECORD* optional, out -> "var"
; pdwBufferLength : DWORD* in/out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "pdh.dll"
#cfunc global PdhReadRawLogRecord "PdhReadRawLogRecord" sptr, int, sptr, sptr
; res = PdhReadRawLogRecord(hLog, ftRecord, varptr(pRawLogRecord), varptr(pdwBufferLength))
; hLog : PDH_HLOG -> "sptr"
; ftRecord : FILETIME -> "int"
; pRawLogRecord : PDH_RAW_LOG_RECORD* optional, out -> "sptr"
; pdwBufferLength : DWORD* in/out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。