ホーム › Storage.FileSystem › AddLogContainer

AddLogContainer

関数

CLFSログにコンテナを一つ追加する。

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

シグネチャ

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

BOOL AddLogContainer(
    HANDLE hLog,
    ULONGLONG* pcbContainer,   // optional
    LPWSTR pwszContainerPath,
    void* pReserved   // optional
);

パラメーター

名前	型	方向	説明
hLog	HANDLE	in	開いているログへのハンドル。このハンドルは、ログへの書き込みアクセス権を指定して CreateLogFile から取得する必要があります。クライアントアプリケーションは、.blf ファイルへの書き込みアクセス権と、コンテナーのターゲットディレクトリにファイルを作成する権限を持っている必要があります。
pcbContainer	ULONGLONG*	inoptional	コンテナーのサイズをバイト単位で指定する省略可能なパラメーターです。最小サイズは、通常のログでは 512 KB、多重化されたログでは 1024 KB です。最大サイズは約 4 ギガバイトです。このパラメーターは、新しく作成されたログにコンテナーを追加する場合に必要です。コンテナーが既に作成されている場合、このパラメーターは NULL、または最初のコンテナーのサイズ以上の値を指定できます。ログコンテナーのサイズは、ログリージョンサイズ (512 KB) の倍数です。新しいファイルにコンテナーを追加すると、AddLogContainer 関数はコンテナーのサイズを次の 512 KB の境界に切り上げ、そのサイズを pcbContainer が指す値として返します。同様に、ログに少なくとも 1 つのコンテナーが既にあり、pcbContainer の値が現在のコンテナーサイズ以上である場合、この関数はすべてのコンテナーを現在の内部サイズで作成し、そのサイズを pcbContainer に返します。
pwszContainerPath	LPWSTR	in	ログボリューム上の新しいコンテナーの有効なパスを含む null 終端文字列へのポインター。
pReserved	void*	inoutoptional	予約済み。 pReserved には NULL を設定します。

戻り値の型: BOOL

公式ドキュメント

呼び出し元プロセスが .blf ファイルへの書き込みアクセス権を持ち、コンテナーのターゲットディレクトリにファイルを作成できる場合に、ログハンドルに関連付けられた物理ログにコンテナーを追加します。

戻り値

関数が成功した場合、戻り値は 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 AddLogContainer(
    HANDLE hLog,
    ULONGLONG* pcbContainer,   // optional
    LPWSTR pwszContainerPath,
    void* pReserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("clfsw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AddLogContainer(
    IntPtr hLog,   // HANDLE
    IntPtr pcbContainer,   // ULONGLONG* optional
    [MarshalAs(UnmanagedType.LPWStr)] string pwszContainerPath,   // LPWSTR
    IntPtr pReserved   // void* optional, in/out
);

<DllImport("clfsw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AddLogContainer(
    hLog As IntPtr,   ' HANDLE
    pcbContainer As IntPtr,   ' ULONGLONG* optional
    <MarshalAs(UnmanagedType.LPWStr)> pwszContainerPath As String,   ' LPWSTR
    pReserved As IntPtr   ' void* optional, in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hLog : HANDLE
' pcbContainer : ULONGLONG* optional
' pwszContainerPath : LPWSTR
' pReserved : void* optional, in/out
Declare PtrSafe Function AddLogContainer Lib "clfsw32" ( _
    ByVal hLog As LongPtr, _
    ByVal pcbContainer As LongPtr, _
    ByVal pwszContainerPath As LongPtr, _
    ByVal pReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AddLogContainer = ctypes.windll.clfsw32.AddLogContainer
AddLogContainer.restype = wintypes.BOOL
AddLogContainer.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    ctypes.POINTER(ctypes.c_ulonglong),  # pcbContainer : ULONGLONG* optional
    wintypes.LPCWSTR,  # pwszContainerPath : LPWSTR
    ctypes.POINTER(None),  # pReserved : void* optional, in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('clfsw32.dll')
AddLogContainer = Fiddle::Function.new(
  lib['AddLogContainer'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    Fiddle::TYPE_VOIDP,  # pcbContainer : ULONGLONG* optional
    Fiddle::TYPE_VOIDP,  # pwszContainerPath : LPWSTR
    Fiddle::TYPE_VOIDP,  # pReserved : void* optional, in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn AddLogContainer(
        hLog: *mut core::ffi::c_void,  // HANDLE
        pcbContainer: *mut u64,  // ULONGLONG* optional
        pwszContainerPath: *mut u16,  // LPWSTR
        pReserved: *mut ()  // void* optional, 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 AddLogContainer(IntPtr hLog, IntPtr pcbContainer, [MarshalAs(UnmanagedType.LPWStr)] string pwszContainerPath, IntPtr pReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_AddLogContainer' -Namespace Win32 -PassThru
# $api::AddLogContainer(hLog, pcbContainer, pwszContainerPath, pReserved)

#uselib "clfsw32.dll"
#func global AddLogContainer "AddLogContainer" sptr, sptr, sptr, sptr
; AddLogContainer hLog, varptr(pcbContainer), pwszContainerPath, pReserved   ; 戻り値は stat
; hLog : HANDLE -> "sptr"
; pcbContainer : ULONGLONG* optional -> "sptr"
; pwszContainerPath : LPWSTR -> "sptr"
; pReserved : void* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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