ホーム › Storage.FileSystem › GetLogFileInformation

GetLogFileInformation

関数

CLFSログファイルの構成情報や状態を取得する。

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

シグネチャ

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

BOOL GetLogFileInformation(
    HANDLE hLog,
    CLS_INFORMATION* pinfoBuffer,
    DWORD* cbBuffer
);

パラメーター

名前	型	方向	説明
hLog	HANDLE	in	CreateLogFile の呼び出しが成功して取得した、オープン済みのログへのハンドルです。このログハンドルは、専用ログまたは多重化ログのいずれかを参照できます。
pinfoBuffer	CLS_INFORMATION*	inout	ログのメタデータを受け取る、ユーザーが割り当てた CLFS_INFORMATION 構造体へのポインターです。
cbBuffer	DWORD*	inout	入力時には、pinfoBuffer が指すメタデータバッファのサイズ (バイト単位) を指定する変数へのポインターです。出力時には、pinfoBuffer に実際にコピーされたバイト数を指定します。

名前

型

方向

説明

hLog

HANDLE

CreateLogFile の呼び出しが成功して取得した、オープン済みのログへのハンドルです。

このログハンドルは、専用ログまたは多重化ログのいずれかを参照できます。

pinfoBuffer

CLS_INFORMATION*

inout

ログのメタデータを受け取る、ユーザーが割り当てた CLFS_INFORMATION 構造体へのポインターです。

cbBuffer

DWORD*

inout

入力時には、pinfoBuffer が指すメタデータバッファのサイズ (バイト単位) を指定する変数へのポインターです。

出力時には、pinfoBuffer に実際にコピーされたバイト数を指定します。

戻り値の型: BOOL

公式ドキュメント

指定したログとその現在の状態に関するメタデータを格納したバッファを返します。この状態は CLFS_INFORMATION 構造体によって定義されます。

戻り値

関数が成功した場合、戻り値は 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 GetLogFileInformation(
    HANDLE hLog,
    CLS_INFORMATION* pinfoBuffer,
    DWORD* cbBuffer
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetLogFileInformation(
    IntPtr hLog,   // HANDLE
    IntPtr pinfoBuffer,   // CLS_INFORMATION* in/out
    ref uint cbBuffer   // DWORD* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetLogFileInformation(
    hLog As IntPtr,   ' HANDLE
    pinfoBuffer As IntPtr,   ' CLS_INFORMATION* in/out
    ByRef cbBuffer As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hLog : HANDLE
' pinfoBuffer : CLS_INFORMATION* in/out
' cbBuffer : DWORD* in/out
Declare PtrSafe Function GetLogFileInformation Lib "clfsw32" ( _
    ByVal hLog As LongPtr, _
    ByVal pinfoBuffer As LongPtr, _
    ByRef cbBuffer As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetLogFileInformation = ctypes.windll.clfsw32.GetLogFileInformation
GetLogFileInformation.restype = wintypes.BOOL
GetLogFileInformation.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    ctypes.c_void_p,  # pinfoBuffer : CLS_INFORMATION* in/out
    ctypes.POINTER(wintypes.DWORD),  # cbBuffer : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
GetLogFileInformation = Fiddle::Function.new(
  lib['GetLogFileInformation'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    Fiddle::TYPE_VOIDP,  # pinfoBuffer : CLS_INFORMATION* in/out
    Fiddle::TYPE_VOIDP,  # cbBuffer : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn GetLogFileInformation(
        hLog: *mut core::ffi::c_void,  // HANDLE
        pinfoBuffer: *mut CLS_INFORMATION,  // CLS_INFORMATION* in/out
        cbBuffer: *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 GetLogFileInformation(IntPtr hLog, IntPtr pinfoBuffer, ref uint cbBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_GetLogFileInformation' -Namespace Win32 -PassThru
# $api::GetLogFileInformation(hLog, pinfoBuffer, cbBuffer)

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

出力引数:

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