DeleteLogFile 関数 (clfsw32.h)

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

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

メモ密接に関連する関数は DeleteLogByHandle であり、ファイルのハンドルが指定されるとログが削除されます。

構文

CLFSUSER_API BOOL DeleteLogFile(
  [in]           LPCWSTR pszLogFileName,
  [in, optional] PVOID   pvReserved
);

[in] pszLogFileName

ログの名前。

この名前は、 CreateLogFile を使用してログを作成するときに指定されます。次の例では、使用する形式を識別します。

ログ：<log name>[::<log stream name>]

<ログ名> は、ファイルシステム内の有効なファイルパスに対応します。

<ログストリーム名> は、ログ内のログストリームの一意の名前です。

詳細については、「ログの種類」を参照してください。

[in, optional] pvReserved

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

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

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

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