ホーム › Storage.FileSystem › GetLogIoStatistics

GetLogIoStatistics

関数

CLFSログのI/O統計情報を取得する。

DLLclfsw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL GetLogIoStatistics(
    HANDLE hLog,
    void* pvStatsBuffer,
    DWORD cbStatsBuffer,
    CLFS_IOSTATS_CLASS eStatsClass,
    DWORD* pcbStatsWritten
);

パラメーター

名前	型	方向	説明
hLog	HANDLE	in	CreateLogFile が取得した、開いているログファイルへのハンドル。このログハンドルは、専用ログファイルまたは多重化ログファイルのいずれかを参照できます。
pvStatsBuffer	void*	inout	I/O 統計情報を受け取るバッファーへのポインター。このバッファーは、少なくとも I/O 統計情報パケットヘッダーと同じ大きさである必要があります。詳細については、CLFS_IO_STATISTICS_HEADER を参照してください。
cbStatsBuffer	DWORD	in	I/O 統計情報バッファー pvStatsBuffer のサイズ (バイト単位)。バッファーが統計情報パケットに対して十分な大きさでない場合、この関数は ERROR_MORE_DATA で失敗します。
eStatsClass	CLFS_IOSTATS_CLASS	in	このパラメーターは現時点では実装されておらず、将来の使用のために予約されています。
pcbStatsWritten	DWORD*	inout	pvStatsBuffer に書き込まれた I/O 統計情報パケットのサイズを受け取る変数へのポインター。この値は cbStatsBuffer 以下になります。

戻り値の型: BOOL

公式ドキュメント

指定したハンドルに関連付けられた専用ログまたは多重化ログのログ I/O 統計情報を取得します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。次の一覧は、発生し得るエラーコードを示しています。

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

各言語での呼び出し定義

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

BOOL GetLogIoStatistics(
    HANDLE hLog,
    void* pvStatsBuffer,
    DWORD cbStatsBuffer,
    CLFS_IOSTATS_CLASS eStatsClass,
    DWORD* pcbStatsWritten
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetLogIoStatistics(
    IntPtr hLog,   // HANDLE
    IntPtr pvStatsBuffer,   // void* in/out
    uint cbStatsBuffer,   // DWORD
    int eStatsClass,   // CLFS_IOSTATS_CLASS
    ref uint pcbStatsWritten   // DWORD* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetLogIoStatistics(
    hLog As IntPtr,   ' HANDLE
    pvStatsBuffer As IntPtr,   ' void* in/out
    cbStatsBuffer As UInteger,   ' DWORD
    eStatsClass As Integer,   ' CLFS_IOSTATS_CLASS
    ByRef pcbStatsWritten As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hLog : HANDLE
' pvStatsBuffer : void* in/out
' cbStatsBuffer : DWORD
' eStatsClass : CLFS_IOSTATS_CLASS
' pcbStatsWritten : DWORD* in/out
Declare PtrSafe Function GetLogIoStatistics Lib "clfsw32" ( _
    ByVal hLog As LongPtr, _
    ByVal pvStatsBuffer As LongPtr, _
    ByVal cbStatsBuffer As Long, _
    ByVal eStatsClass As Long, _
    ByRef pcbStatsWritten As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetLogIoStatistics = ctypes.windll.clfsw32.GetLogIoStatistics
GetLogIoStatistics.restype = wintypes.BOOL
GetLogIoStatistics.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    ctypes.POINTER(None),  # pvStatsBuffer : void* in/out
    wintypes.DWORD,  # cbStatsBuffer : DWORD
    ctypes.c_int,  # eStatsClass : CLFS_IOSTATS_CLASS
    ctypes.POINTER(wintypes.DWORD),  # pcbStatsWritten : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
GetLogIoStatistics = Fiddle::Function.new(
  lib['GetLogIoStatistics'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    Fiddle::TYPE_VOIDP,  # pvStatsBuffer : void* in/out
    -Fiddle::TYPE_INT,  # cbStatsBuffer : DWORD
    Fiddle::TYPE_INT,  # eStatsClass : CLFS_IOSTATS_CLASS
    Fiddle::TYPE_VOIDP,  # pcbStatsWritten : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn GetLogIoStatistics(
        hLog: *mut core::ffi::c_void,  // HANDLE
        pvStatsBuffer: *mut (),  // void* in/out
        cbStatsBuffer: u32,  // DWORD
        eStatsClass: i32,  // CLFS_IOSTATS_CLASS
        pcbStatsWritten: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true)]
public static extern bool GetLogIoStatistics(IntPtr hLog, IntPtr pvStatsBuffer, uint cbStatsBuffer, int eStatsClass, ref uint pcbStatsWritten);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_GetLogIoStatistics' -Namespace Win32 -PassThru
# $api::GetLogIoStatistics(hLog, pvStatsBuffer, cbStatsBuffer, eStatsClass, pcbStatsWritten)

#uselib "clfsw32.dll"
#func global GetLogIoStatistics "GetLogIoStatistics" sptr, sptr, sptr, sptr, sptr
; GetLogIoStatistics hLog, pvStatsBuffer, cbStatsBuffer, eStatsClass, varptr(pcbStatsWritten)   ; 戻り値は stat
; hLog : HANDLE -> "sptr"
; pvStatsBuffer : void* in/out -> "sptr"
; cbStatsBuffer : DWORD -> "sptr"
; eStatsClass : CLFS_IOSTATS_CLASS -> "sptr"
; pcbStatsWritten : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "clfsw32.dll"
#cfunc global GetLogIoStatistics "GetLogIoStatistics" sptr, sptr, int, int, var
; res = GetLogIoStatistics(hLog, pvStatsBuffer, cbStatsBuffer, eStatsClass, pcbStatsWritten)
; hLog : HANDLE -> "sptr"
; pvStatsBuffer : void* in/out -> "sptr"
; cbStatsBuffer : DWORD -> "int"
; eStatsClass : CLFS_IOSTATS_CLASS -> "int"
; pcbStatsWritten : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "clfsw32.dll"
#cfunc global GetLogIoStatistics "GetLogIoStatistics" sptr, sptr, int, int, sptr
; res = GetLogIoStatistics(hLog, pvStatsBuffer, cbStatsBuffer, eStatsClass, varptr(pcbStatsWritten))
; hLog : HANDLE -> "sptr"
; pvStatsBuffer : void* in/out -> "sptr"
; cbStatsBuffer : DWORD -> "int"
; eStatsClass : CLFS_IOSTATS_CLASS -> "int"
; pcbStatsWritten : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。