Win32 API 日本語リファレンス
ホームSystem.EventLog › EvtExportLog

EvtExportLog

関数
条件に合うイベントをファイルへエクスポートする。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// wevtapi.dll
#include <windows.h>

BOOL EvtExportLog(
    EVT_HANDLE Session,   // optional
    LPCWSTR Path,   // optional
    LPCWSTR Query,   // optional
    LPCWSTR TargetFilePath,
    DWORD Flags
);

パラメーター

名前方向説明
SessionEVT_HANDLEinoptionalEvtOpenSession 関数が返すリモート セッション ハンドル。ローカル チャネルの場合は NULL を指定します。
PathLPCWSTRinoptionalエクスポートするイベントが含まれるチャネルの名前、またはログ ファイルへの完全パス。Query パラメーターに XPath クエリを指定する場合は、チャネルまたはログ ファイルを指定する必要があります。Flags パラメーターに EvtExportLogFilePath を指定する場合は、ログ ファイルを指定する必要があります。Query パラメーターに構造化 XML クエリを指定する場合、ここで指定するチャネルまたはパスは、クエリ内のチャネルまたはパスと一致している必要があります。Flags パラメーターに EvtExportLogChannelPath を指定する場合、クエリがチャネルを指定する構造化 XML クエリであれば、このパラメーターは NULL にできます。
QueryLPCWSTRinoptionalエクスポートするイベントの種類を指定するクエリ。XPath 1.0 クエリまたは構造化 XML クエリを指定できます。XPath に 20 を超える式が含まれる場合は、構造化 XML クエリを使用してください。すべてのイベントをエクスポートするには、このパラメーターを NULL または "*" に設定します。
TargetFilePathLPCWSTRinイベントを受け取るターゲット ログ ファイルへの完全パス。ターゲット ログ ファイルは存在していてはいけません。
FlagsDWORDinイベントの取得元がチャネルかログ ファイルかを示すフラグ。指定可能な値については、EVT_EXPORTLOG_FLAGS 列挙型を参照してください。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

戻り値/値 説明
TRUE
関数は成功しました。
FALSE
関数は失敗しました。エラー コードを取得するには GetLastError 関数を使用してください。

解説(Remarks)

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

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

ターゲット ログ ファイルには絶対パスを指定する必要があります。ターゲット ログ ファイルの指定に相対パスや環境変数を使用することはできません。パスには Universal Naming Convention (UNC) パスを使用できます。ファイル名拡張子には .evtx を使用してください。

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

この関数の使用方法を示す例については、Saving Events to a Log File を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// wevtapi.dll
#include <windows.h>

BOOL EvtExportLog(
    EVT_HANDLE Session,   // optional
    LPCWSTR Path,   // optional
    LPCWSTR Query,   // optional
    LPCWSTR TargetFilePath,
    DWORD Flags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EvtExportLog(
    IntPtr Session,   // EVT_HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string Path,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string Query,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string TargetFilePath,   // LPCWSTR
    uint Flags   // DWORD
);
<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtExportLog(
    Session As IntPtr,   ' EVT_HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> Path As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> Query As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> TargetFilePath As String,   ' LPCWSTR
    Flags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Session : EVT_HANDLE optional
' Path : LPCWSTR optional
' Query : LPCWSTR optional
' TargetFilePath : LPCWSTR
' Flags : DWORD
Declare PtrSafe Function EvtExportLog Lib "wevtapi" ( _
    ByVal Session As LongPtr, _
    ByVal Path As LongPtr, _
    ByVal Query As LongPtr, _
    ByVal TargetFilePath As LongPtr, _
    ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EvtExportLog = ctypes.windll.wevtapi.EvtExportLog
EvtExportLog.restype = wintypes.BOOL
EvtExportLog.argtypes = [
    ctypes.c_ssize_t,  # Session : EVT_HANDLE optional
    wintypes.LPCWSTR,  # Path : LPCWSTR optional
    wintypes.LPCWSTR,  # Query : LPCWSTR optional
    wintypes.LPCWSTR,  # TargetFilePath : LPCWSTR
    wintypes.DWORD,  # Flags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wevtapi.dll')
EvtExportLog = Fiddle::Function.new(
  lib['EvtExportLog'],
  [
    Fiddle::TYPE_INTPTR_T,  # Session : EVT_HANDLE optional
    Fiddle::TYPE_VOIDP,  # Path : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # Query : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # TargetFilePath : LPCWSTR
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "wevtapi")]
extern "system" {
    fn EvtExportLog(
        Session: isize,  // EVT_HANDLE optional
        Path: *const u16,  // LPCWSTR optional
        Query: *const u16,  // LPCWSTR optional
        TargetFilePath: *const u16,  // LPCWSTR
        Flags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("wevtapi.dll", SetLastError = true)]
public static extern bool EvtExportLog(IntPtr Session, [MarshalAs(UnmanagedType.LPWStr)] string Path, [MarshalAs(UnmanagedType.LPWStr)] string Query, [MarshalAs(UnmanagedType.LPWStr)] string TargetFilePath, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtExportLog' -Namespace Win32 -PassThru
# $api::EvtExportLog(Session, Path, Query, TargetFilePath, Flags)
#uselib "wevtapi.dll"
#func global EvtExportLog "EvtExportLog" sptr, sptr, sptr, sptr, sptr
; EvtExportLog Session, Path, Query, TargetFilePath, Flags   ; 戻り値は stat
; Session : EVT_HANDLE optional -> "sptr"
; Path : LPCWSTR optional -> "sptr"
; Query : LPCWSTR optional -> "sptr"
; TargetFilePath : LPCWSTR -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "wevtapi.dll"
#cfunc global EvtExportLog "EvtExportLog" sptr, wstr, wstr, wstr, int
; res = EvtExportLog(Session, Path, Query, TargetFilePath, Flags)
; Session : EVT_HANDLE optional -> "sptr"
; Path : LPCWSTR optional -> "wstr"
; Query : LPCWSTR optional -> "wstr"
; TargetFilePath : LPCWSTR -> "wstr"
; Flags : DWORD -> "int"
; BOOL EvtExportLog(EVT_HANDLE Session, LPCWSTR Path, LPCWSTR Query, LPCWSTR TargetFilePath, DWORD Flags)
#uselib "wevtapi.dll"
#cfunc global EvtExportLog "EvtExportLog" intptr, wstr, wstr, wstr, int
; res = EvtExportLog(Session, Path, Query, TargetFilePath, Flags)
; Session : EVT_HANDLE optional -> "intptr"
; Path : LPCWSTR optional -> "wstr"
; Query : LPCWSTR optional -> "wstr"
; TargetFilePath : LPCWSTR -> "wstr"
; Flags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtExportLog = wevtapi.NewProc("EvtExportLog")
)

// Session (EVT_HANDLE optional), Path (LPCWSTR optional), Query (LPCWSTR optional), TargetFilePath (LPCWSTR), Flags (DWORD)
r1, _, err := procEvtExportLog.Call(
	uintptr(Session),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Path))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Query))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(TargetFilePath))),
	uintptr(Flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EvtExportLog(
  Session: NativeInt;   // EVT_HANDLE optional
  Path: PWideChar;   // LPCWSTR optional
  Query: PWideChar;   // LPCWSTR optional
  TargetFilePath: PWideChar;   // LPCWSTR
  Flags: DWORD   // DWORD
): BOOL; stdcall;
  external 'wevtapi.dll' name 'EvtExportLog';
result := DllCall("wevtapi\EvtExportLog"
    , "Ptr", Session   ; EVT_HANDLE optional
    , "WStr", Path   ; LPCWSTR optional
    , "WStr", Query   ; LPCWSTR optional
    , "WStr", TargetFilePath   ; LPCWSTR
    , "UInt", Flags   ; DWORD
    , "Int")   ; return: BOOL
●EvtExportLog(Session, Path, Query, TargetFilePath, Flags) = DLL("wevtapi.dll", "bool EvtExportLog(int, char*, char*, char*, dword)")
# 呼び出し: EvtExportLog(Session, Path, Query, TargetFilePath, Flags)
# Session : EVT_HANDLE optional -> "int"
# Path : LPCWSTR optional -> "char*"
# Query : LPCWSTR optional -> "char*"
# TargetFilePath : LPCWSTR -> "char*"
# Flags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wevtapi" fn EvtExportLog(
    Session: isize, // EVT_HANDLE optional
    Path: [*c]const u16, // LPCWSTR optional
    Query: [*c]const u16, // LPCWSTR optional
    TargetFilePath: [*c]const u16, // LPCWSTR
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc EvtExportLog(
    Session: int,  # EVT_HANDLE optional
    Path: WideCString,  # LPCWSTR optional
    Query: WideCString,  # LPCWSTR optional
    TargetFilePath: WideCString,  # LPCWSTR
    Flags: uint32  # DWORD
): int32 {.importc: "EvtExportLog", stdcall, dynlib: "wevtapi.dll".}
pragma(lib, "wevtapi");
extern(Windows)
int EvtExportLog(
    ptrdiff_t Session,   // EVT_HANDLE optional
    const(wchar)* Path,   // LPCWSTR optional
    const(wchar)* Query,   // LPCWSTR optional
    const(wchar)* TargetFilePath,   // LPCWSTR
    uint Flags   // DWORD
);
ccall((:EvtExportLog, "wevtapi.dll"), stdcall, Int32,
      (Int, Cwstring, Cwstring, Cwstring, UInt32),
      Session, Path, Query, TargetFilePath, Flags)
# Session : EVT_HANDLE optional -> Int
# Path : LPCWSTR optional -> Cwstring
# Query : LPCWSTR optional -> Cwstring
# TargetFilePath : LPCWSTR -> Cwstring
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t EvtExportLog(
    intptr_t Session,
    const uint16_t* Path,
    const uint16_t* Query,
    const uint16_t* TargetFilePath,
    uint32_t Flags);
]]
local wevtapi = ffi.load("wevtapi")
-- wevtapi.EvtExportLog(Session, Path, Query, TargetFilePath, Flags)
-- Session : EVT_HANDLE optional
-- Path : LPCWSTR optional
-- Query : LPCWSTR optional
-- TargetFilePath : LPCWSTR
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wevtapi.dll');
const EvtExportLog = lib.func('__stdcall', 'EvtExportLog', 'int32_t', ['intptr_t', 'str16', 'str16', 'str16', 'uint32_t']);
// EvtExportLog(Session, Path, Query, TargetFilePath, Flags)
// Session : EVT_HANDLE optional -> 'intptr_t'
// Path : LPCWSTR optional -> 'str16'
// Query : LPCWSTR optional -> 'str16'
// TargetFilePath : LPCWSTR -> 'str16'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wevtapi.dll", {
  EvtExportLog: { parameters: ["isize", "buffer", "buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.EvtExportLog(Session, Path, Query, TargetFilePath, Flags)
// Session : EVT_HANDLE optional -> "isize"
// Path : LPCWSTR optional -> "buffer"
// Query : LPCWSTR optional -> "buffer"
// TargetFilePath : LPCWSTR -> "buffer"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EvtExportLog(
    intptr_t Session,
    const uint16_t* Path,
    const uint16_t* Query,
    const uint16_t* TargetFilePath,
    uint32_t Flags);
C, "wevtapi.dll");
// $ffi->EvtExportLog(Session, Path, Query, TargetFilePath, Flags);
// Session : EVT_HANDLE optional
// Path : LPCWSTR optional
// Query : LPCWSTR optional
// TargetFilePath : LPCWSTR
// Flags : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wevtapi extends StdCallLibrary {
    Wevtapi INSTANCE = Native.load("wevtapi", Wevtapi.class);
    boolean EvtExportLog(
        long Session,   // EVT_HANDLE optional
        WString Path,   // LPCWSTR optional
        WString Query,   // LPCWSTR optional
        WString TargetFilePath,   // LPCWSTR
        int Flags   // DWORD
    );
}
@[Link("wevtapi")]
lib Libwevtapi
  fun EvtExportLog = EvtExportLog(
    Session : LibC::SSizeT,   # EVT_HANDLE optional
    Path : UInt16*,   # LPCWSTR optional
    Query : UInt16*,   # LPCWSTR optional
    TargetFilePath : UInt16*,   # LPCWSTR
    Flags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EvtExportLogNative = Int32 Function(IntPtr, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef EvtExportLogDart = int Function(int, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, int);
final EvtExportLog = DynamicLibrary.open('wevtapi.dll')
    .lookupFunction<EvtExportLogNative, EvtExportLogDart>('EvtExportLog');
// Session : EVT_HANDLE optional -> IntPtr
// Path : LPCWSTR optional -> Pointer<Utf16>
// Query : LPCWSTR optional -> Pointer<Utf16>
// TargetFilePath : LPCWSTR -> Pointer<Utf16>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EvtExportLog(
  Session: NativeInt;   // EVT_HANDLE optional
  Path: PWideChar;   // LPCWSTR optional
  Query: PWideChar;   // LPCWSTR optional
  TargetFilePath: PWideChar;   // LPCWSTR
  Flags: DWORD   // DWORD
): BOOL; stdcall;
  external 'wevtapi.dll' name 'EvtExportLog';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EvtExportLog"
  c_EvtExportLog :: CIntPtr -> CWString -> CWString -> CWString -> Word32 -> IO CInt
-- Session : EVT_HANDLE optional -> CIntPtr
-- Path : LPCWSTR optional -> CWString
-- Query : LPCWSTR optional -> CWString
-- TargetFilePath : LPCWSTR -> CWString
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let evtexportlog =
  foreign "EvtExportLog"
    (intptr_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* Session : EVT_HANDLE optional -> intptr_t *)
(* Path : LPCWSTR optional -> (ptr uint16_t) *)
(* Query : LPCWSTR optional -> (ptr uint16_t) *)
(* TargetFilePath : LPCWSTR -> (ptr uint16_t) *)
(* Flags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wevtapi (t "wevtapi.dll"))
(cffi:use-foreign-library wevtapi)

(cffi:defcfun ("EvtExportLog" evt-export-log :convention :stdcall) :int32
  (session :int64)   ; EVT_HANDLE optional
  (path (:string :encoding :utf-16le))   ; LPCWSTR optional
  (query (:string :encoding :utf-16le))   ; LPCWSTR optional
  (target-file-path (:string :encoding :utf-16le))   ; LPCWSTR
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EvtExportLog = Win32::API::More->new('wevtapi',
    'BOOL EvtExportLog(LPARAM Session, LPCWSTR Path, LPCWSTR Query, LPCWSTR TargetFilePath, DWORD Flags)');
# my $ret = $EvtExportLog->Call($Session, $Path, $Query, $TargetFilePath, $Flags);
# Session : EVT_HANDLE optional -> LPARAM
# Path : LPCWSTR optional -> LPCWSTR
# Query : LPCWSTR optional -> LPCWSTR
# TargetFilePath : LPCWSTR -> LPCWSTR
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目