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

EvtArchiveExportedLog

関数
エクスポート済みログをアーカイブ化する。
DLLwevtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL EvtArchiveExportedLog(
    EVT_HANDLE Session,   // optional
    LPCWSTR LogFilePath,
    DWORD Locale,
    DWORD Flags
);

パラメーター

名前方向説明
SessionEVT_HANDLEinoptionalEvtOpenSession 関数が返すリモートセッションハンドル。ローカルチャネルの場合は NULL を設定します。
LogFilePathLPCWSTRinローカライズ対象のイベントを含むエクスポート済みログファイルへのフルパス。
LocaleDWORDinサービスがログファイル内のイベントに追加する文字列のローカライズに使用するロケール。ゼロの場合、関数は呼び出し元スレッドのロケールを使用します。プロバイダーのリソースに該当するロケールが含まれていない場合、文字列は空になります。
FlagsDWORDin予約済み。ゼロを指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

指定したログファイル内のイベントにローカライズされた文字列を追加します。

戻り値

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

解説(Remarks)

エクスポート済みログファイルからイベントを読み取るには、そのイベントのリソース(メッセージ文字列)を提供するプロバイダーが利用可能である必要があります。この関数を呼び出してローカライズされたリソースをイベントに含めておくことで、プロバイダーが利用できない場合でもイベントを読み取れるようになります。

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

各言語での呼び出し定義

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

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

EvtArchiveExportedLog = ctypes.windll.wevtapi.EvtArchiveExportedLog
EvtArchiveExportedLog.restype = wintypes.BOOL
EvtArchiveExportedLog.argtypes = [
    ctypes.c_ssize_t,  # Session : EVT_HANDLE optional
    wintypes.LPCWSTR,  # LogFilePath : LPCWSTR
    wintypes.DWORD,  # Locale : DWORD
    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')
EvtArchiveExportedLog = Fiddle::Function.new(
  lib['EvtArchiveExportedLog'],
  [
    Fiddle::TYPE_INTPTR_T,  # Session : EVT_HANDLE optional
    Fiddle::TYPE_VOIDP,  # LogFilePath : LPCWSTR
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "wevtapi")]
extern "system" {
    fn EvtArchiveExportedLog(
        Session: isize,  // EVT_HANDLE optional
        LogFilePath: *const u16,  // LPCWSTR
        Locale: u32,  // DWORD
        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 EvtArchiveExportedLog(IntPtr Session, [MarshalAs(UnmanagedType.LPWStr)] string LogFilePath, uint Locale, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtArchiveExportedLog' -Namespace Win32 -PassThru
# $api::EvtArchiveExportedLog(Session, LogFilePath, Locale, Flags)
#uselib "wevtapi.dll"
#func global EvtArchiveExportedLog "EvtArchiveExportedLog" sptr, sptr, sptr, sptr
; EvtArchiveExportedLog Session, LogFilePath, Locale, Flags   ; 戻り値は stat
; Session : EVT_HANDLE optional -> "sptr"
; LogFilePath : LPCWSTR -> "sptr"
; Locale : DWORD -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "wevtapi.dll"
#cfunc global EvtArchiveExportedLog "EvtArchiveExportedLog" sptr, wstr, int, int
; res = EvtArchiveExportedLog(Session, LogFilePath, Locale, Flags)
; Session : EVT_HANDLE optional -> "sptr"
; LogFilePath : LPCWSTR -> "wstr"
; Locale : DWORD -> "int"
; Flags : DWORD -> "int"
; BOOL EvtArchiveExportedLog(EVT_HANDLE Session, LPCWSTR LogFilePath, DWORD Locale, DWORD Flags)
#uselib "wevtapi.dll"
#cfunc global EvtArchiveExportedLog "EvtArchiveExportedLog" intptr, wstr, int, int
; res = EvtArchiveExportedLog(Session, LogFilePath, Locale, Flags)
; Session : EVT_HANDLE optional -> "intptr"
; LogFilePath : LPCWSTR -> "wstr"
; Locale : DWORD -> "int"
; Flags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
	procEvtArchiveExportedLog = wevtapi.NewProc("EvtArchiveExportedLog")
)

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

extern "wevtapi" fn EvtArchiveExportedLog(
    Session: isize, // EVT_HANDLE optional
    LogFilePath: [*c]const u16, // LPCWSTR
    Locale: u32, // DWORD
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc EvtArchiveExportedLog(
    Session: int,  # EVT_HANDLE optional
    LogFilePath: WideCString,  # LPCWSTR
    Locale: uint32,  # DWORD
    Flags: uint32  # DWORD
): int32 {.importc: "EvtArchiveExportedLog", stdcall, dynlib: "wevtapi.dll".}
pragma(lib, "wevtapi");
extern(Windows)
int EvtArchiveExportedLog(
    ptrdiff_t Session,   // EVT_HANDLE optional
    const(wchar)* LogFilePath,   // LPCWSTR
    uint Locale,   // DWORD
    uint Flags   // DWORD
);
ccall((:EvtArchiveExportedLog, "wevtapi.dll"), stdcall, Int32,
      (Int, Cwstring, UInt32, UInt32),
      Session, LogFilePath, Locale, Flags)
# Session : EVT_HANDLE optional -> Int
# LogFilePath : LPCWSTR -> Cwstring
# Locale : DWORD -> UInt32
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t EvtArchiveExportedLog(
    intptr_t Session,
    const uint16_t* LogFilePath,
    uint32_t Locale,
    uint32_t Flags);
]]
local wevtapi = ffi.load("wevtapi")
-- wevtapi.EvtArchiveExportedLog(Session, LogFilePath, Locale, Flags)
-- Session : EVT_HANDLE optional
-- LogFilePath : LPCWSTR
-- Locale : DWORD
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wevtapi.dll');
const EvtArchiveExportedLog = lib.func('__stdcall', 'EvtArchiveExportedLog', 'int32_t', ['intptr_t', 'str16', 'uint32_t', 'uint32_t']);
// EvtArchiveExportedLog(Session, LogFilePath, Locale, Flags)
// Session : EVT_HANDLE optional -> 'intptr_t'
// LogFilePath : LPCWSTR -> 'str16'
// Locale : DWORD -> 'uint32_t'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wevtapi.dll", {
  EvtArchiveExportedLog: { parameters: ["isize", "buffer", "u32", "u32"], result: "i32" },
});
// lib.symbols.EvtArchiveExportedLog(Session, LogFilePath, Locale, Flags)
// Session : EVT_HANDLE optional -> "isize"
// LogFilePath : LPCWSTR -> "buffer"
// Locale : DWORD -> "u32"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EvtArchiveExportedLog(
    intptr_t Session,
    const uint16_t* LogFilePath,
    uint32_t Locale,
    uint32_t Flags);
C, "wevtapi.dll");
// $ffi->EvtArchiveExportedLog(Session, LogFilePath, Locale, Flags);
// Session : EVT_HANDLE optional
// LogFilePath : LPCWSTR
// Locale : DWORD
// 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 EvtArchiveExportedLog(
        long Session,   // EVT_HANDLE optional
        WString LogFilePath,   // LPCWSTR
        int Locale,   // DWORD
        int Flags   // DWORD
    );
}
@[Link("wevtapi")]
lib Libwevtapi
  fun EvtArchiveExportedLog = EvtArchiveExportedLog(
    Session : LibC::SSizeT,   # EVT_HANDLE optional
    LogFilePath : UInt16*,   # LPCWSTR
    Locale : UInt32,   # DWORD
    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 EvtArchiveExportedLogNative = Int32 Function(IntPtr, Pointer<Utf16>, Uint32, Uint32);
typedef EvtArchiveExportedLogDart = int Function(int, Pointer<Utf16>, int, int);
final EvtArchiveExportedLog = DynamicLibrary.open('wevtapi.dll')
    .lookupFunction<EvtArchiveExportedLogNative, EvtArchiveExportedLogDart>('EvtArchiveExportedLog');
// Session : EVT_HANDLE optional -> IntPtr
// LogFilePath : LPCWSTR -> Pointer<Utf16>
// Locale : DWORD -> Uint32
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EvtArchiveExportedLog(
  Session: NativeInt;   // EVT_HANDLE optional
  LogFilePath: PWideChar;   // LPCWSTR
  Locale: DWORD;   // DWORD
  Flags: DWORD   // DWORD
): BOOL; stdcall;
  external 'wevtapi.dll' name 'EvtArchiveExportedLog';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let evtarchiveexportedlog =
  foreign "EvtArchiveExportedLog"
    (intptr_t @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* Session : EVT_HANDLE optional -> intptr_t *)
(* LogFilePath : LPCWSTR -> (ptr uint16_t) *)
(* Locale : DWORD -> uint32_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 ("EvtArchiveExportedLog" evt-archive-exported-log :convention :stdcall) :int32
  (session :int64)   ; EVT_HANDLE optional
  (log-file-path (:string :encoding :utf-16le))   ; LPCWSTR
  (locale :uint32)   ; DWORD
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EvtArchiveExportedLog = Win32::API::More->new('wevtapi',
    'BOOL EvtArchiveExportedLog(LPARAM Session, LPCWSTR LogFilePath, DWORD Locale, DWORD Flags)');
# my $ret = $EvtArchiveExportedLog->Call($Session, $LogFilePath, $Locale, $Flags);
# Session : EVT_HANDLE optional -> LPARAM
# LogFilePath : LPCWSTR -> LPCWSTR
# Locale : DWORD -> DWORD
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目