ClfsDeleteLogFile 関数 (wdm.h)

ClfsDeleteLogFile ルーチンは、CLFS ストリームを削除対象としてマークします。

構文

CLFSUSER_API NTSTATUS ClfsDeleteLogFile(
  [in]           PUNICODE_STRING puszLogFileName,
                 PVOID           pvReserved,
  [in]           ULONG           fLogOptionFlag,
  [in, optional] PVOID           pvContext,
  [in]           ULONG           cbContext
);

パラメーター

[in] puszLogFileName

削除する CLFS ストリームの名前を提供する UNICODE_STRING 構造体へのポインター。

削除するストリームが専用ログの唯一のストリームである場合、名前には物理ログ名という形式のログがあります。物理ログ名 は、基になるファイル システム上の物理ログのパス名です。

削除するストリームが多重化されたログのストリームの 1 つである場合、名前には、物理ログ名::ストリーム名という形式のログがあります。物理ログ名 は、基になるファイル システム上の物理ログのパス名で、ストリーム名 は削除するストリームの一意の名前です。

pvReserved

引っ込み思案。

[in] fLogOptionFlag

CLFS とログを削除するコンポーネントの関係を示す値。 使用可能な値の一覧については、ClfsCreateLogFile ルーチンの fLogOptionFlag パラメーターの説明を参照してください。

[in, optional] pvContext

コンテキストへのポインター。 コンテキストの解釈方法は、fLogOptionFlag 渡される値によって異なります。

[in] cbContext

pvContex tが指すコンテキストのサイズ (バイト単位)。 pvContext NULL でない場合、このパラメーターは 0 より大きい値にする必要があります。

戻り値

clfsDeleteLogFile 成功した場合、STATUS_SUCCESSが返されます。それ以外の場合は、Ntstatus.h で定義されているエラー コードのいずれかを返します。

備考

共通ログ ファイル システム (CLFS) は、LOG_FILE_OBJECT構造を使用してログを表します。 ClfsCreateLogFile 関数は、クライアントが他の CLFS 関数に渡すLOG_FILE_OBJECTへのポインターを返します。

CLFS クライアントは、LOG_FILE_OBJECT構造体のメンバーに直接アクセスしません。 メンバーの詳細については、FILE_OBJECTを参照してください。

clfsDeleteLogFile 、ストリームの削除をマークしますが、現在開いているログ ファイル オブジェクトは閉じません。 ログ ファイル オブジェクトを閉じるには、ClfsCloseLogFileObject 呼び出します。 削除対象としてマークされたストリームは、ストリームに関連付けられているすべてのログ ファイル オブジェクトが閉じられた後に削除されます。

削除対象としてマークされた CLFS ストリームは、ストリームを開く後続の要求を拒否します。

物理 CLFS ログの名前には、.blf 拡張子は含まれません。

CLFS の概念と用語については、「共通ログ ファイル システムの」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows Server 2003 R2、Windows Vista、およびそれ以降のバージョンの Windows で使用できます。
ターゲット プラットフォーム の	デスクトップ
ヘッダー	wdm.h (Wdm.h を含む)
ライブラリ	Clfs.lib
DLL	Clfs.sys
IRQL	<= APC_LEVEL

関連項目

ClfsCloseAndResetLogFile の

ClfsCloseLogFileObject の

ClfsCreateLogFile の

ClfsDeleteLogByPointer の