次の方法で共有

ClearEventLogA 関数 (winbase.h)

  • [アーティクル]

指定したイベント ログをクリアし、必要に応じて、ログの現在のコピーをバックアップ ファイルに保存します。

構文

BOOL ClearEventLogA(
  [in] HANDLE hEventLog,
  [in] LPCSTR lpBackupFileName
);

パラメーター

[in] hEventLog

クリアするイベント ログのハンドル。 OpenEventLog 関数は、このハンドルを返します。

[in] lpBackupFileName

バックアップ ファイルの絶対パスまたは相対パス。 このファイルが既に存在する場合、関数は失敗します。

lpBackupFileName パラメーターが NULL の場合、イベント ログはバックアップされません。

戻り値

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

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。 イベント ログが空であるか、バックアップ ファイルが既に存在する場合、 ClearEventLog 関数は失敗する可能性があります。

解説

この関数が戻った後は、クリアされたイベント ログを参照するハンドルを使用してログを読み取ることはできません。

注意

winbase.h ヘッダーは、ClearEventLog をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winbase.h (Windows.h を含む)
Library Advapi32.lib
[DLL] Advapi32.dll
API セット ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (Windows 10 バージョン 10.0.10240 で導入)

関連項目

イベント ログ関数

OpenEventLog