ValidateLog

関数

CLFSログファイルの整合性を検証し情報を取得する。

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

シグネチャ

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

BOOL ValidateLog(
    LPCWSTR pszLogFileName,
    SECURITY_ATTRIBUTES* psaLogFile,
    CLS_INFORMATION* pinfoBuffer,
    DWORD* pcbBuffer
);

パラメーター

名前	型	方向	説明
pszLogFileName	LPCWSTR	in	ログの名前。名前は、CreateLogFile を使用してログを作成するときに指定します。次の例は、使用する形式を示しています。 Log:<LogName>[::<LogStreamName>] <LogName> は、ファイルシステム内の有効なファイルパスに対応します。 <LogStreamName> は、専用ログ内のログストリームの一意の名前です。詳細については、Log Types を参照してください。
psaLogFile	SECURITY_ATTRIBUTES*	inout	ログのセキュリティ属性を指定する SECURITY_ATTRIBUTES 構造体へのポインター。このパラメーターは NULL にすることができます。
pinfoBuffer	CLS_INFORMATION*	inout	ログのメタデータを受け取る CLFS_INFORMATION 構造体へのポインター。
pcbBuffer	DWORD*	inout	入力時に、pinfoBuffer メタデータバッファーのサイズをバイト単位で指定する変数へのポインター。出力時には、バッファーにコピーされた情報の量をバイト単位で受け取ります。

戻り値の型: BOOL

公式ドキュメント

ログのアーカイブ前およびログの復元後に、ログのメタデータとデータの整合性を検証します。

戻り値

関数が成功した場合、戻り値は 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 ValidateLog(
    LPCWSTR pszLogFileName,
    SECURITY_ATTRIBUTES* psaLogFile,
    CLS_INFORMATION* pinfoBuffer,
    DWORD* pcbBuffer
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ValidateLog(
    [MarshalAs(UnmanagedType.LPWStr)] string pszLogFileName,   // LPCWSTR
    IntPtr psaLogFile,   // SECURITY_ATTRIBUTES* in/out
    IntPtr pinfoBuffer,   // CLS_INFORMATION* in/out
    ref uint pcbBuffer   // DWORD* in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ValidateLog(
    <MarshalAs(UnmanagedType.LPWStr)> pszLogFileName As String,   ' LPCWSTR
    psaLogFile As IntPtr,   ' SECURITY_ATTRIBUTES* in/out
    pinfoBuffer As IntPtr,   ' CLS_INFORMATION* in/out
    ByRef pcbBuffer As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pszLogFileName : LPCWSTR
' psaLogFile : SECURITY_ATTRIBUTES* in/out
' pinfoBuffer : CLS_INFORMATION* in/out
' pcbBuffer : DWORD* in/out
Declare PtrSafe Function ValidateLog Lib "clfsw32" ( _
    ByVal pszLogFileName As LongPtr, _
    ByVal psaLogFile As LongPtr, _
    ByVal pinfoBuffer As LongPtr, _
    ByRef pcbBuffer As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ValidateLog = ctypes.windll.clfsw32.ValidateLog
ValidateLog.restype = wintypes.BOOL
ValidateLog.argtypes = [
    wintypes.LPCWSTR,  # pszLogFileName : LPCWSTR
    ctypes.c_void_p,  # psaLogFile : SECURITY_ATTRIBUTES* in/out
    ctypes.c_void_p,  # pinfoBuffer : CLS_INFORMATION* in/out
    ctypes.POINTER(wintypes.DWORD),  # pcbBuffer : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
ValidateLog = Fiddle::Function.new(
  lib['ValidateLog'],
  [
    Fiddle::TYPE_VOIDP,  # pszLogFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # psaLogFile : SECURITY_ATTRIBUTES* in/out
    Fiddle::TYPE_VOIDP,  # pinfoBuffer : CLS_INFORMATION* in/out
    Fiddle::TYPE_VOIDP,  # pcbBuffer : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn ValidateLog(
        pszLogFileName: *const u16,  // LPCWSTR
        psaLogFile: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* in/out
        pinfoBuffer: *mut CLS_INFORMATION,  // CLS_INFORMATION* in/out
        pcbBuffer: *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 ValidateLog([MarshalAs(UnmanagedType.LPWStr)] string pszLogFileName, IntPtr psaLogFile, IntPtr pinfoBuffer, ref uint pcbBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_ValidateLog' -Namespace Win32 -PassThru
# $api::ValidateLog(pszLogFileName, psaLogFile, pinfoBuffer, pcbBuffer)

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

出力引数:

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