RemoveLogContainer 関数 (clfsw32.h)

専用または多重化されたログ ハンドルに関連付けられているログから 1 つのコンテナーを削除します。

コンテナーを削除するには、ログ ハンドルに対する管理者特権がクライアントに必要です。 複数のコンテナーを削除するには、 RemoveLogContainerSet 関数を使用します。

構文

CLFSUSER_API BOOL RemoveLogContainer(
  [in]                HANDLE hLog,
  [in]                LPWSTR pwszContainerPath,
  [in]                BOOL   fForce,
  [in, out, optional] LPVOID pReserved
);

パラメーター

[in] hLog

CreateLogFile から取得されたログへのハンドル。

[in] pwszContainerPath

AddLogContainer または AddLogContainerSet によって作成されるログ コンテナーのパスを含むワイド文字列へのポインター。

[in] fForce

コンテナーを削除するタイミングと方法を決定する削除フラグ。

fForce が TRUE で、コンテナーがアクティブなログ領域の一部である場合、コンテナーは削除されず、エラー ERROR_LOG_CANT_DELETEが返されます。

FALSE の場合、コンテナーがアクティブなログ領域の一部ではなくなったときにコンテナーが削除されます。

[in, out, optional] pReserved

このパラメーターは予約されており、 NULL に設定する必要があります。

戻り値

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

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

次の一覧は、考えられるエラー コードを示しています。

注釈

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

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

要件

こちらもご覧ください

AddLogContainer

AddLogContainerSet

一般的なログ ファイル システム関数

OVERLAPPED

RemoveLogContainerSet