PdhOpenLogA

関数

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

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

szLogFileName

LPCSTR

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

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

dwAccessFlags

PDH_LOG

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

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

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

値	意味
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 パラメーターで示されるユーザーキャプションまたはログファイルの説明を書き込みます。ユーザーキャプションまたはログファイルの説明は、テキストログの 1 行目の最後の列として書き込まれます。

lpdwLogType

PDH_LOG_TYPE*

inout

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

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

hQuery

PDH_HQUERY

inoptional

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

ログファイルから読み取る場合、このパラメーターは無視されるため NULL を指定してください。

dwMaxSize

DWORD

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

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

szUserCaption

LPCSTR

inoptional

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

phLog

PDH_HLOG*

out

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

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

例

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

メモ

pdh.h ヘッダーは、PdhOpenLog を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不整合が生じ、コンパイルエラーまたは実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PdhOpenLogA(
    LPCSTR szLogFileName,
    PDH_LOG dwAccessFlags,
    PDH_LOG_TYPE* lpdwLogType,
    PDH_HQUERY hQuery,   // optional
    DWORD dwMaxSize,
    LPCSTR szUserCaption,   // optional
    PDH_HLOG* phLog
);

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

<DllImport("pdh.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PdhOpenLogA(
    <MarshalAs(UnmanagedType.LPStr)> szLogFileName As String,   ' LPCSTR
    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.LPStr)> szUserCaption As String,   ' LPCSTR optional
    phLog As IntPtr   ' PDH_HLOG* out
) As UInteger
End Function

' szLogFileName : LPCSTR
' dwAccessFlags : PDH_LOG
' lpdwLogType : PDH_LOG_TYPE* in/out
' hQuery : PDH_HQUERY optional
' dwMaxSize : DWORD
' szUserCaption : LPCSTR optional
' phLog : PDH_HLOG* out
Declare PtrSafe Function PdhOpenLogA Lib "pdh" ( _
    ByVal szLogFileName As String, _
    ByVal dwAccessFlags As Long, _
    ByRef lpdwLogType As Long, _
    ByVal hQuery As LongPtr, _
    ByVal dwMaxSize As Long, _
    ByVal szUserCaption As String, _
    ByVal phLog As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhOpenLogA = ctypes.windll.pdh.PdhOpenLogA
PdhOpenLogA.restype = wintypes.DWORD
PdhOpenLogA.argtypes = [
    wintypes.LPCSTR,  # szLogFileName : LPCSTR
    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.LPCSTR,  # szUserCaption : LPCSTR optional
    ctypes.c_void_p,  # phLog : PDH_HLOG* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhOpenLogA = Fiddle::Function.new(
  lib['PdhOpenLogA'],
  [
    Fiddle::TYPE_VOIDP,  # szLogFileName : LPCSTR
    -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 : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # phLog : PDH_HLOG* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhOpenLogA(
        szLogFileName: *const u8,  // LPCSTR
        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 u8,  // LPCSTR 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.Ansi)]
public static extern uint PdhOpenLogA([MarshalAs(UnmanagedType.LPStr)] string szLogFileName, uint dwAccessFlags, ref uint lpdwLogType, IntPtr hQuery, uint dwMaxSize, [MarshalAs(UnmanagedType.LPStr)] string szUserCaption, IntPtr phLog);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhOpenLogA' -Namespace Win32 -PassThru
# $api::PdhOpenLogA(szLogFileName, dwAccessFlags, lpdwLogType, hQuery, dwMaxSize, szUserCaption, phLog)

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

出力引数:

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