ホーム › Storage.FileSystem › RemoveLogContainerSet

RemoveLogContainerSet

関数

CLFSログから指定したコンテナ群をまとめて削除する。

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

シグネチャ

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

BOOL RemoveLogContainerSet(
    HANDLE hLog,
    WORD cContainer,
    LPWSTR* rgwszContainerPath,
    BOOL fForce,
    void* pReserved   // optional
);

パラメーター

名前	型	方向	説明
hLog	HANDLE	in	CreateLogFile から取得したログへのハンドルです。このログハンドルには、ログコンテナーを追加するための管理者権限が必要であり、専用ログまたは多重化ログのいずれかを参照できます。
cContainer	WORD	in	rgwszContainerPath が指す配列内のコンテナーパス名の数です。この値は 0 以外でなければなりません。
rgwszContainerPath	LPWSTR*	in	cContainers 個のポインターを格納する、コンテナーパス名へのポインターの配列です。各パス名は、AddLogContainer または AddLogContainerSet のいずれかによって作成されたコンテナーを識別するワイド文字列です。
fForce	BOOL	in	コンテナーをいつどのように削除するかを決定する削除フラグです。 fForce が TRUE で、かつコンテナーがアクティブなログ領域の一部である場合、コンテナーは削除されず、エラー ERROR_LOG_CANT_DELETE が返されます。 FALSE の場合、コンテナーは、それがアクティブなログ領域の一部でなくなった時点で削除されます。
pReserved	void*	inoutoptional	予約済みです。pReserved には NULL を設定してください。

戻り値の型: BOOL

公式ドキュメント

専用ハンドルまたは多重化ハンドルに関連付けられたログから、複数のコンテナーを削除します。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

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

解説(Remarks)

既定では、コンテナーの削除は遅延的に行われます。つまり、コンテナーがアクティブなログの一部でない場合にのみ削除されます。コンテナーがアクティブなログの一部である場合は、削除対象としてマークされます。この削除は、ログの末尾がそのコンテナーの最後のセクターを超えるか、またはコンテナーの論理識別子がアクティブなログの先頭の論理識別子よりも大きくなるまで延期されます。ログサイズにコンテナーの削除が反映されるのは、コンテナーが物理的に削除されたときのみです。

ログクライアントは、削除フラグを TRUE に設定することで、コンテナーの強制削除を要求できます。これは、アクティブなログの一部でないコンテナーを削除する場合と同じ効果があります。ただし、コンテナーがアクティブなログの一部である場合、呼び出しは失敗し、コンテナーは削除対象としてマークされません。

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

各言語での呼び出し定義

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

BOOL RemoveLogContainerSet(
    HANDLE hLog,
    WORD cContainer,
    LPWSTR* rgwszContainerPath,
    BOOL fForce,
    void* pReserved   // optional
);

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

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

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

import ctypes
from ctypes import wintypes

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

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

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

出力引数:

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