PdhOpenLogW

関数

パフォーマンスデータのログファイルを開く。

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

シグネチャ

// pdh.dll  (Unicode / -W)
#include <windows.h>

DWORD PdhOpenLogW(
    LPCWSTR szLogFileName,
    PDH_LOG dwAccessFlags,
    PDH_LOG_TYPE* lpdwLogType,
    PDH_HQUERY hQuery,   // optional
    DWORD dwMaxSize,
    LPCWSTR szUserCaption,   // optional
    PDH_HLOG* phLog
);

パラメーター

名前

型

方向

説明

szLogFileName

LPCWSTR

開くログファイルの名前を指定する Null 終端文字列です。名前には絶対パスまたは相対パスを含めることができます。

lpdwLogType パラメーターが PDH_LOG_TYPE_SQL の場合は、SQL:DataSourceName!LogFileName という形式でログファイルの名前を指定します。

dwAccessFlags

PDH_LOG

ログファイルを開く際に使用するアクセスの種類です。次のいずれかの値を指定します。

Value	Meaning
PDH_LOG_READ_ACCESS	ログファイルを読み取り用に開きます。
PDH_LOG_WRITE_ACCESS	新しいログファイルを書き込み用に開きます。
PDH_LOG_UPDATE_ACCESS	既存のログファイルを書き込み用に開きます。

ビットごとの論理和 OR 演算子 (|) を使用して、アクセスの種類を次の作成フラグの 1 つ以上と組み合わせることができます。

Value	Meaning
PDH_LOG_CREATE_NEW	指定した名前で新しいログファイルを作成します。
PDH_LOG_CREATE_ALWAYS	指定した名前で新しいログファイルを作成します。同名のログファイルが既に存在する場合、この関数は新しいファイルを作成する前に既存のログファイルを削除します。
PDH_LOG_OPEN_EXISTING	指定した名前の既存のログファイルを開きます。指定した名前のログファイルが存在しない場合は、PDH_LOG_CREATE_NEW と同じ動作になります。
PDH_LOG_OPEN_ALWAYS	指定した名前の既存のログファイルを開くか、指定した名前で新しいログファイルを作成します。
PDH_LOG_OPT_CIRCULAR	指定した名前で循環ログファイルを作成します。ファイルが dwMaxSize パラメーターの値に達すると、データはログファイルの先頭に折り返されます。このフラグは、lpdwLogType パラメーターが PDH_LOG_TYPE_BINARY の場合にのみ指定できます。
PDH_LOG_USER_STRING	PDH_LOG_TYPE_TSV と共に使用し、PdhUpdateLog または PdhOpenLog の szUserString パラメーターで示されるユーザーキャプションまたはログファイルの説明を書き込みます。ユーザーキャプションまたはログファイルの説明は、テキストログの最初の行の最後の列として書き込まれます。

lpdwLogType

PDH_LOG_TYPE*

inout

開くログファイルの種類です。このパラメーターには次のいずれかの値を指定できます。

Value	Meaning
PDH_LOG_TYPE_UNDEFINED	未定義のログファイル形式です。これを指定すると、PDH がログファイルの種類を判別します。dwAccessFlags パラメーターが PDH_LOG_WRITE_ACCESS の場合、この値は指定できません。
PDH_LOG_TYPE_CSV	最初の行に列ヘッダーを含み、それ以降の各行に個々のデータレコードを含むテキストファイルです。各データレコードのフィールドはコンマで区切られます。最初の行には、ファイルの形式、ログファイルの作成に使用された PDH のバージョン、および各カウンターの名前とパスに関する情報も含まれます。
PDH_LOG_TYPE_SQL	ログファイルのデータソースは SQL データベースです。
PDH_LOG_TYPE_TSV	最初の行に列ヘッダーを含み、それ以降の各行に個々のデータレコードを含むテキストファイルです。各データレコードのフィールドはタブで区切られます。最初の行には、ファイルの形式、ログファイルの作成に使用された PDH のバージョン、および各カウンターの名前とパスに関する情報も含まれます。
PDH_LOG_TYPE_BINARY	バイナリログファイル形式です。

hQuery

PDH_HQUERY

inoptional

クエリデータをログファイルに書き込む場合は、クエリハンドルを指定します。このハンドルは PdhOpenQuery 関数によって返されます。

ログファイルから読み取る場合、このパラメーターは無視され、NULL を指定する必要があります。

dwMaxSize

DWORD

ログファイルの最大サイズ (バイト単位) です。ファイルサイズを制限する場合、または dwAccessFlags で PDH_LOG_OPT_CIRCULAR を指定する場合は最大サイズを指定し、それ以外の場合は 0 に設定します。

循環ログファイルの場合は、少なくとも 1 つのサンプルを保持できる十分な大きさの値を指定する必要があります。サンプルサイズは収集されるデータによって異なりますが、少なくとも 1 メガバイトの値を指定すれば、ほとんどのサンプルに対応できます。

szUserCaption

LPCWSTR

inoptional

ログファイルのユーザー定義のキャプションを指定する Null 終端文字列です。ログファイルのキャプションは、通常、ログファイルの内容を説明するものです。既存のログファイルを開く場合、このパラメーターの値は無視されます。

phLog

PDH_HLOG*

out

開いたログファイルへのハンドルです。

戻り値の型: DWORD

公式ドキュメント

指定したログファイルを読み取りまたは書き込み用に開きます。(Unicode)

戻り値

関数が成功すると、ERROR_SUCCESS を返します。

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

解説(Remarks)

この関数を使用してパフォーマンスデータをログファイルに書き込むには、この関数を呼び出す前に、PdhOpenQuery を使用してクエリを開き、目的のカウンターを追加しておく必要があります。

新しいオペレーティングシステムでは、古いオペレーティングシステムで生成されたログファイルを読み取ることができます。ただし、Windows Vista 以降のオペレーティングシステムで作成されたログファイルは、それより前のオペレーティングシステムでは読み取ることができません。

ログファイルには次の規則が適用されます。

READ_ACCESS には OPEN_EXISTING が必要です。
UPDATE_ACCESS はファイルベースのログでは使用できません。データベースログでのみ使用できます。
WRITE_ACCESS には CREATE_NEW、CREATE_ALWAYS、OPEN_EXISTING、OPEN_ALWAYS のいずれかが必要です。

Examples

例については、Writing Performance Data to a Log File を参照してください。

メモ

pdh.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PdhOpenLog を定義します。エンコードニュートラルなエイリアスの使用を、エンコードニュートラルではないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーが発生する可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// pdh.dll  (Unicode / -W)
#include <windows.h>

DWORD PdhOpenLogW(
    LPCWSTR szLogFileName,
    PDH_LOG dwAccessFlags,
    PDH_LOG_TYPE* lpdwLogType,
    PDH_HQUERY hQuery,   // optional
    DWORD dwMaxSize,
    LPCWSTR szUserCaption,   // optional
    PDH_HLOG* phLog
);

[DllImport("pdh.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PdhOpenLogW(
    [MarshalAs(UnmanagedType.LPWStr)] string szLogFileName,   // LPCWSTR
    uint dwAccessFlags,   // PDH_LOG
    ref uint lpdwLogType,   // PDH_LOG_TYPE* in/out
    IntPtr hQuery,   // PDH_HQUERY optional
    uint dwMaxSize,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string szUserCaption,   // LPCWSTR optional
    IntPtr phLog   // PDH_HLOG* out
);

<DllImport("pdh.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PdhOpenLogW(
    <MarshalAs(UnmanagedType.LPWStr)> szLogFileName As String,   ' LPCWSTR
    dwAccessFlags As UInteger,   ' PDH_LOG
    ByRef lpdwLogType As UInteger,   ' PDH_LOG_TYPE* in/out
    hQuery As IntPtr,   ' PDH_HQUERY optional
    dwMaxSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> szUserCaption As String,   ' LPCWSTR optional
    phLog As IntPtr   ' PDH_HLOG* out
) As UInteger
End Function

' szLogFileName : LPCWSTR
' dwAccessFlags : PDH_LOG
' lpdwLogType : PDH_LOG_TYPE* in/out
' hQuery : PDH_HQUERY optional
' dwMaxSize : DWORD
' szUserCaption : LPCWSTR optional
' phLog : PDH_HLOG* out
Declare PtrSafe Function PdhOpenLogW Lib "pdh" ( _
    ByVal szLogFileName As LongPtr, _
    ByVal dwAccessFlags As Long, _
    ByRef lpdwLogType As Long, _
    ByVal hQuery As LongPtr, _
    ByVal dwMaxSize As Long, _
    ByVal szUserCaption As LongPtr, _
    ByVal phLog As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhOpenLogW = ctypes.windll.pdh.PdhOpenLogW
PdhOpenLogW.restype = wintypes.DWORD
PdhOpenLogW.argtypes = [
    wintypes.LPCWSTR,  # szLogFileName : LPCWSTR
    wintypes.DWORD,  # dwAccessFlags : PDH_LOG
    ctypes.c_void_p,  # lpdwLogType : PDH_LOG_TYPE* in/out
    wintypes.HANDLE,  # hQuery : PDH_HQUERY optional
    wintypes.DWORD,  # dwMaxSize : DWORD
    wintypes.LPCWSTR,  # szUserCaption : LPCWSTR optional
    ctypes.c_void_p,  # phLog : PDH_HLOG* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhOpenLogW = Fiddle::Function.new(
  lib['PdhOpenLogW'],
  [
    Fiddle::TYPE_VOIDP,  # szLogFileName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwAccessFlags : PDH_LOG
    Fiddle::TYPE_VOIDP,  # lpdwLogType : PDH_LOG_TYPE* in/out
    Fiddle::TYPE_VOIDP,  # hQuery : PDH_HQUERY optional
    -Fiddle::TYPE_INT,  # dwMaxSize : DWORD
    Fiddle::TYPE_VOIDP,  # szUserCaption : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # phLog : PDH_HLOG* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "pdh")]
extern "system" {
    fn PdhOpenLogW(
        szLogFileName: *const u16,  // LPCWSTR
        dwAccessFlags: u32,  // PDH_LOG
        lpdwLogType: *mut u32,  // PDH_LOG_TYPE* in/out
        hQuery: *mut core::ffi::c_void,  // PDH_HQUERY optional
        dwMaxSize: u32,  // DWORD
        szUserCaption: *const u16,  // LPCWSTR optional
        phLog: *mut *mut core::ffi::c_void  // PDH_HLOG* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll", CharSet = CharSet.Unicode)]
public static extern uint PdhOpenLogW([MarshalAs(UnmanagedType.LPWStr)] string szLogFileName, uint dwAccessFlags, ref uint lpdwLogType, IntPtr hQuery, uint dwMaxSize, [MarshalAs(UnmanagedType.LPWStr)] string szUserCaption, IntPtr phLog);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhOpenLogW' -Namespace Win32 -PassThru
# $api::PdhOpenLogW(szLogFileName, dwAccessFlags, lpdwLogType, hQuery, dwMaxSize, szUserCaption, phLog)

#uselib "pdh.dll"
#func global PdhOpenLogW "PdhOpenLogW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; PdhOpenLogW szLogFileName, dwAccessFlags, varptr(lpdwLogType), hQuery, dwMaxSize, szUserCaption, phLog   ; 戻り値は stat
; szLogFileName : LPCWSTR -> "wptr"
; dwAccessFlags : PDH_LOG -> "wptr"
; lpdwLogType : PDH_LOG_TYPE* in/out -> "wptr"
; hQuery : PDH_HQUERY optional -> "wptr"
; dwMaxSize : DWORD -> "wptr"
; szUserCaption : LPCWSTR optional -> "wptr"
; phLog : PDH_HLOG* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "pdh.dll"
#cfunc global PdhOpenLogW "PdhOpenLogW" wstr, int, var, sptr, int, wstr, sptr
; res = PdhOpenLogW(szLogFileName, dwAccessFlags, lpdwLogType, hQuery, dwMaxSize, szUserCaption, phLog)
; szLogFileName : LPCWSTR -> "wstr"
; dwAccessFlags : PDH_LOG -> "int"
; lpdwLogType : PDH_LOG_TYPE* in/out -> "var"
; hQuery : PDH_HQUERY optional -> "sptr"
; dwMaxSize : DWORD -> "int"
; szUserCaption : LPCWSTR optional -> "wstr"
; phLog : PDH_HLOG* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "pdh.dll"
#cfunc global PdhOpenLogW "PdhOpenLogW" wstr, int, sptr, sptr, int, wstr, sptr
; res = PdhOpenLogW(szLogFileName, dwAccessFlags, varptr(lpdwLogType), hQuery, dwMaxSize, szUserCaption, phLog)
; szLogFileName : LPCWSTR -> "wstr"
; dwAccessFlags : PDH_LOG -> "int"
; lpdwLogType : PDH_LOG_TYPE* in/out -> "sptr"
; hQuery : PDH_HQUERY optional -> "sptr"
; dwMaxSize : DWORD -> "int"
; szUserCaption : LPCWSTR optional -> "wstr"
; phLog : PDH_HLOG* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。