DeleteLogByHandle 関数 (clfsw32.h)

指定したログに削除のマークを付けます。ログは、すべてのハンドル、マーシャリング領域、およびログへの読み取りコンテキストが閉じられると、実際に削除されます。ログが物理ログの場合、その基になるコンテナーは削除されます。

ログが削除対象としてマークされると、新しいクライアントログストリームを開く要求は失敗します。

メモこの関数は、ログ名ではなくログオブジェクトに対して有効なオープンハンドルを受け取るため、 DeleteLogFile とは異なります。

構文

CLFSUSER_API BOOL DeleteLogByHandle(
  [in] HANDLE hLog
);

[in] hLog

CreateLogFile の正常な呼び出しによって取得される開いているログへのハンドル。ログは DELETE アクセスで作成されている必要があります。または、ログを削除することはできません。

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

関数が失敗した場合は、0 を返します。詳細なエラー情報を得るには、GetLastError を呼び出します。次の一覧は、考えられるエラーコードを示しています。

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2003 R2 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	clfsw32.h
Library	Clfsw32.lib
[DLL]	Clfsw32.dll