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構造体へのポインター。

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

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

pvReserved

予約済み。

[in] fLogOptionFlag

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

[in, optional] pvContext

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

[in] cbContext

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

戻り値

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

注釈

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

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

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

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

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

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

要件

こちらもご覧ください

ClfsCloseAndResetLogFile

ClfsCloseLogFileObject

ClfsCreateLogFile

ClfsDeleteLogByPointer