Share via

EvtExportLog 関数 (winevt.h)

  • [アーティクル]

指定したチャネルまたはログ ファイルからイベントをコピーし、ターゲット ログ ファイルに書き込みます。

構文

BOOL EvtExportLog(
  [in, optional] EVT_HANDLE Session,
  [in]           LPCWSTR    Path,
  [in]           LPCWSTR    Query,
  [in]           LPCWSTR    TargetFilePath,
  [in]           DWORD      Flags
);

パラメーター

[in, optional] Session

EvtOpenSession 関数が返すリモート セッション ハンドル。 ローカル チャネルの 場合は NULL に設定します。

[in] Path

エクスポートするイベントを含む、チャネルの名前またはログ ファイルへの完全なパス。 Query パラメーターに XPath クエリが含まれている場合は、チャネルまたはログ ファイルを指定する必要があります。 Flags パラメーターに EvtExportLogFilePath が含まれている場合は、ログ ファイルを指定する必要があります。 Query パラメーターに構造化 XML クエリが含まれている場合、ここで指定するチャネルまたはパスは、クエリ内のチャネルまたはパスと一致する必要があります。 Flags パラメーターに EvtExportLogChannelPath が含まれている場合、クエリがチャネルを指定する構造化 XML クエリである場合、このパラメーターは NULL になります。

[in] Query

エクスポートするイベントの種類を指定するクエリ。 XPath 1.0 クエリまたは構造化 XML クエリを指定できます。 XPath に 20 を超える式が含まれている場合は、構造化 XML クエリを使用します。 すべてのイベントをエクスポートするには、このパラメーターを NULL または "*" に設定します。

[in] TargetFilePath

イベントを受信するターゲット ログ ファイルへの完全パス。 ターゲット ログ ファイルが存在してはなりません。

[in] Flags

イベントがチャネルまたはログ ファイルから送信されるかどうかを示すフラグ。 使用可能な値については、 EVT_EXPORTLOG_FLAGS 列挙を参照してください。

戻り値

リターン コード/値 説明
TRUE
 関数が正常に実行されました。
FALSE
 関数が失敗しました。 エラー コードを取得するには、 GetLastError 関数を使用します。

注釈

構造化 XML クエリを使用して、複数のチャネルからイベントをエクスポートできます ( イベントの使用に関するページを参照)。ただし、この関数を使用して複数のログ ファイルからイベントをマージすることはできません。 クエリ結果が空の場合、サービスはヘッダー情報を含むがイベントを含まないファイルを作成します。

チャネルからイベントを削除し、ターゲット ログ ファイルに書き込むには、 EvtClearLog 関数を呼び出します。 ログ ファイル内のイベントにローカライズされた文字列を含めるには、 EvtArchiveExportedLog 関数を呼び出します。

ターゲット ログ ファイルへの絶対パスを指定する必要があります。相対パスと環境変数を使用してターゲット ログ ファイルを指定することはできません。 パスには、汎用名前付け規則 (UNC) パスを指定できます。 ファイル名拡張子として .evtx を使用する必要があります。

この関数は、指定されたチャネルまたはログ ファイルにのみ影響します。チャネルで autoBackup または fileMax を使用している場合、この関数はそれらのバックアップ ファイルには影響しません。

例

この関数の使用方法を示す例については、「 ログ ファイルへのイベントの保存」を参照してください。

要件

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

こちらもご覧ください

EvtArchiveExportedLog

EvtClearLog