ホーム › Storage.FileSystem › AddLogContainerSet

AddLogContainerSet

関数

CLFSログに複数のコンテナをまとめて追加する。

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

シグネチャ

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

BOOL AddLogContainerSet(
    HANDLE hLog,
    WORD cContainer,
    ULONGLONG* pcbContainer,   // optional
    LPWSTR* rgwszContainerPath,
    void* pReserved   // optional
);

パラメーター

名前	型	方向	説明
hLog	HANDLE	in	ログコンテナーを追加する権限を持つ、CreateLogFile から取得した、開かれているログへのハンドル。ファイルは専用 (dedicated) と多重化 (multiplexed) のいずれでもかまいません。
cContainer	WORD	in	rgwszContainerPath 配列内のコンテナー数。この値は 0 以外でなければなりません。ログに対して I/O を実行するには、ログに少なくとも 2 つのコンテナーが必要です。
pcbContainer	ULONGLONG*	inoptional	コンテナーのサイズ (バイト単位)。最小サイズは、通常のログでは 512 KB、多重化ログでは 1024 KB です。最大サイズは約 4 ギガバイト (GB) です。このパラメーターは、新しく作成されたログにコンテナーを追加する場合に必要です。コンテナーが既に作成されている場合、このパラメーターは NULL、または最初のコンテナーのサイズ以上の値にできます。ログコンテナーのサイズは、ログリージョンサイズ (512 KB) の倍数です。新しいファイルにコンテナーを追加すると、AddLogContainer 関数はコンテナーのサイズを次の 512 KB 境界に切り上げ、そのサイズを pcbContainer が指す値に返します。同様に、ログに既に少なくとも 1 つのコンテナーがあり、pcbContainer の値が現在のコンテナーサイズ以上である場合、この関数はすべてのコンテナーを現在の内部サイズで作成し、そのサイズを pcbContainer に返します。
rgwszContainerPath	LPWSTR*	in	コンテナーの cContainer 個のパス名の配列。配列の各要素は、ログボリューム内の新しいコンテナーの有効なパスを含むワイド文字列です。
pReserved	void*	inoutoptional	予約済み。Reserved には NULL を設定します。

戻り値の型: BOOL

公式ドキュメント

呼び出し元プロセスがログハンドルへのアクセス権を持っている場合に、そのログハンドルに関連付けられた物理ログへ複数のログコンテナーを追加します。

戻り値

関数が成功すると、戻り値は 0 以外になり、すべてのコンテナーがログに正常に追加されたことを示します。

関数が失敗すると、戻り値は 0 になり、いずれのコンテナーも追加されなかったことを示します。拡張エラー情報を取得するには、GetLastError を呼び出します。

次の一覧に、発生し得るエラーコードを示します。

解説(Remarks)

AddLogContainerSet 関数はアトミックではありません。たとえば無効なパス名などによって操作が中断された場合、AddLogContainerSet の呼び出しは失敗を返しますが、一部のコンテナーは作成されている可能性があります。アプリケーションは、たとえばどのコンテナーが追加されたかを判別するなどして、このエラーから回復する必要があります。

AddLogContainerSet は複数のコンテナーを追加するため、コンテナーを 1 つだけ追加する AddLogContainer を繰り返し呼び出すよりも効率的です。

コンテナーは非圧縮モードで作成および開かれ、作成時に 0 (ゼロ) で初期化されます。

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

各言語での呼び出し定義

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

BOOL AddLogContainerSet(
    HANDLE hLog,
    WORD cContainer,
    ULONGLONG* pcbContainer,   // optional
    LPWSTR* rgwszContainerPath,
    void* pReserved   // optional
);

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

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

' hLog : HANDLE
' cContainer : WORD
' pcbContainer : ULONGLONG* optional
' rgwszContainerPath : LPWSTR*
' pReserved : void* optional, in/out
Declare PtrSafe Function AddLogContainerSet Lib "clfsw32" ( _
    ByVal hLog As LongPtr, _
    ByVal cContainer As Integer, _
    ByVal pcbContainer As LongPtr, _
    ByVal rgwszContainerPath 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

AddLogContainerSet = ctypes.windll.clfsw32.AddLogContainerSet
AddLogContainerSet.restype = wintypes.BOOL
AddLogContainerSet.argtypes = [
    wintypes.HANDLE,  # hLog : HANDLE
    ctypes.c_ushort,  # cContainer : WORD
    ctypes.POINTER(ctypes.c_ulonglong),  # pcbContainer : ULONGLONG* optional
    ctypes.c_void_p,  # rgwszContainerPath : 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')
AddLogContainerSet = Fiddle::Function.new(
  lib['AddLogContainerSet'],
  [
    Fiddle::TYPE_VOIDP,  # hLog : HANDLE
    -Fiddle::TYPE_SHORT,  # cContainer : WORD
    Fiddle::TYPE_VOIDP,  # pcbContainer : ULONGLONG* optional
    Fiddle::TYPE_VOIDP,  # rgwszContainerPath : LPWSTR*
    Fiddle::TYPE_VOIDP,  # pReserved : void* optional, in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "clfsw32")]
extern "system" {
    fn AddLogContainerSet(
        hLog: *mut core::ffi::c_void,  // HANDLE
        cContainer: u16,  // WORD
        pcbContainer: *mut u64,  // ULONGLONG* optional
        rgwszContainerPath: *mut *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 AddLogContainerSet(IntPtr hLog, ushort cContainer, IntPtr pcbContainer, IntPtr rgwszContainerPath, IntPtr pReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'clfsw32_AddLogContainerSet' -Namespace Win32 -PassThru
# $api::AddLogContainerSet(hLog, cContainer, pcbContainer, rgwszContainerPath, pReserved)

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

出力引数:

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