ホーム › System.Performance › PdhGetLogFileSize

PdhGetLogFileSize

関数

ログファイルの現在のサイズを取得する。

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

シグネチャ

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

DWORD PdhGetLogFileSize(
    PDH_HLOG hLog,
    LONGLONG* llSize
);

パラメーター

名前	型	方向	説明
hLog	PDH_HLOG	in	ログファイルのハンドル。 PdhOpenLog 関数または PdhBindInputDataSource 関数がこのハンドルを返します。
llSize	LONGLONG*	out	ログファイルのサイズ(バイト単位)。

戻り値の型: DWORD

公式ドキュメント

指定したログファイルのサイズを返します。

戻り値

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

関数が失敗した場合、戻り値はシステムエラーコードまたは PDH エラーコードです。次の値が返される可能性があります。

戻り値	説明
PDH_LOG_FILE_OPEN_ERROR	ログファイルを開こうとした際にエラーが発生しました。
PDH_INVALID_HANDLE	ハンドルが無効です。

解説(Remarks)

ログファイルハンドルが複数のバインドされたログファイルを指している場合、サイズはすべてのログファイルの合計になります。ログファイルが SQL ログファイルの場合、llSize パラメーターはログファイル内のレコード数になります。

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

各言語での呼び出し定義

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

DWORD PdhGetLogFileSize(
    PDH_HLOG hLog,
    LONGLONG* llSize
);

[DllImport("pdh.dll", ExactSpelling = true)]
static extern uint PdhGetLogFileSize(
    IntPtr hLog,   // PDH_HLOG
    out long llSize   // LONGLONG* out
);

<DllImport("pdh.dll", ExactSpelling:=True)>
Public Shared Function PdhGetLogFileSize(
    hLog As IntPtr,   ' PDH_HLOG
    <Out> ByRef llSize As Long   ' LONGLONG* out
) As UInteger
End Function

' hLog : PDH_HLOG
' llSize : LONGLONG* out
Declare PtrSafe Function PdhGetLogFileSize Lib "pdh" ( _
    ByVal hLog As LongPtr, _
    ByRef llSize As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PdhGetLogFileSize = ctypes.windll.pdh.PdhGetLogFileSize
PdhGetLogFileSize.restype = wintypes.DWORD
PdhGetLogFileSize.argtypes = [
    wintypes.HANDLE,  # hLog : PDH_HLOG
    ctypes.POINTER(ctypes.c_longlong),  # llSize : LONGLONG* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('pdh.dll')
PdhGetLogFileSize = Fiddle::Function.new(
  lib['PdhGetLogFileSize'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : PDH_HLOG
    Fiddle::TYPE_VOIDP,  # llSize : LONGLONG* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "pdh")]
extern "system" {
    fn PdhGetLogFileSize(
        hLog: *mut core::ffi::c_void,  // PDH_HLOG
        llSize: *mut i64  // LONGLONG* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("pdh.dll")]
public static extern uint PdhGetLogFileSize(IntPtr hLog, out long llSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'pdh_PdhGetLogFileSize' -Namespace Win32 -PassThru
# $api::PdhGetLogFileSize(hLog, llSize)

#uselib "pdh.dll"
#func global PdhGetLogFileSize "PdhGetLogFileSize" sptr, sptr
; PdhGetLogFileSize hLog, varptr(llSize)   ; 戻り値は stat
; hLog : PDH_HLOG -> "sptr"
; llSize : LONGLONG* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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