DeleteLogFile 関数 (clfsw32.h)

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

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

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

構文

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

[in] pszLogFileName

ログの名前。

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

ログ: ログ名[:: ログストリーム名]

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

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

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

[in, optional] pvReserved

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

関数が成功した場合、戻り値は 0 以外です。

関数が失敗した場合、戻り値はゼロ (0) になります。拡張エラー情報を取得するには、GetLastError呼び出します。次の一覧は、考えられるエラーコードを示しています。

要件	価値
サポートされる最小クライアント	Windows Vista [デスクトップアプリのみ]
サポートされる最小サーバー	Windows Server 2003 R2 [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	clfsw32.h
ライブラリ	Clfsw32.lib
DLL	Clfsw32.dll