EvtClearLog 関数 (winevt.h)
指定したチャネルからすべてのイベントを削除し、ターゲット ログ ファイルに書き込みます。
構文
BOOL EvtClearLog(
[in, optional] EVT_HANDLE Session,
[in] LPCWSTR ChannelPath,
[in, optional] LPCWSTR TargetFilePath,
[in] DWORD Flags
);
パラメーター
[in, optional] Session
EvtOpenSession 関数が返すリモート セッション ハンドル。 ローカル チャネルの 場合は NULL に設定します。
[in] ChannelPath
クリアするチャネルの名前。
[in, optional] TargetFilePath
イベントを受信するターゲット ログ ファイルへの完全なパス。 ログ ファイルをクリアし、イベントを保存しない場合は NULL に設定します。
[in] Flags
予約済み。 ゼロを指定してください。
戻り値
リターン コード/値 | 説明 |
---|---|
|
関数が正常に実行されました。 |
|
関数が失敗しました。 GetLastError 関数を使用して、エラー コードを取得します。 |
注釈
チャネルまたはログ ファイルからイベントをコピーするには、 EvtExportLog 関数を呼び出します。
ターゲット ログ ファイルへの絶対パスを指定する必要があります。相対パスと環境変数を使用してターゲット ログ ファイルを指定することはできません。 パスには、汎用名前付け規則 (UNC) パスを指定できます。 ファイル名拡張子として .evtx を使用する必要があります。
この関数はチャネルにのみ影響します。チャネルで autoBackup または fileMax が使用されている場合、この関数はそれらのバックアップ ファイルには影響しません。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | winevt.h |
Library | Wevtapi.lib |
[DLL] | Wevtapi.dll |