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

BackupEventLogW

関数
イベントログをファイルにバックアップする(Unicode版)。
DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL BackupEventLogW(
    HANDLE hEventLog,
    LPCWSTR lpBackupFileName
);

パラメーター

名前方向説明
hEventLogHANDLEin開いているイベントログへのハンドル。OpenEventLog 関数がこのハンドルを返します。
lpBackupFileNameLPCWSTRinバックアップファイルの絶対パスまたは相対パス。

戻り値の型: BOOL

公式ドキュメント

指定したイベントログをバックアップファイルに保存します。(Unicode)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。詳細なエラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

ユーザーが SE_BACKUP_NAME 特権を持っていない場合、BackupEventLog 関数は ERROR_PRIVILEGE_NOT_HELD エラーで失敗します。

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして BackupEventLog を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が発生し、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL BackupEventLogW(
    HANDLE hEventLog,
    LPCWSTR lpBackupFileName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool BackupEventLogW(
    IntPtr hEventLog,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string lpBackupFileName   // LPCWSTR
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BackupEventLogW(
    hEventLog As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> lpBackupFileName As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hEventLog : HANDLE
' lpBackupFileName : LPCWSTR
Declare PtrSafe Function BackupEventLogW Lib "advapi32" ( _
    ByVal hEventLog As LongPtr, _
    ByVal lpBackupFileName As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BackupEventLogW = ctypes.windll.advapi32.BackupEventLogW
BackupEventLogW.restype = wintypes.BOOL
BackupEventLogW.argtypes = [
    wintypes.HANDLE,  # hEventLog : HANDLE
    wintypes.LPCWSTR,  # lpBackupFileName : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
BackupEventLogW = Fiddle::Function.new(
  lib['BackupEventLogW'],
  [
    Fiddle::TYPE_VOIDP,  # hEventLog : HANDLE
    Fiddle::TYPE_VOIDP,  # lpBackupFileName : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "advapi32")]
extern "system" {
    fn BackupEventLogW(
        hEventLog: *mut core::ffi::c_void,  // HANDLE
        lpBackupFileName: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool BackupEventLogW(IntPtr hEventLog, [MarshalAs(UnmanagedType.LPWStr)] string lpBackupFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_BackupEventLogW' -Namespace Win32 -PassThru
# $api::BackupEventLogW(hEventLog, lpBackupFileName)
#uselib "ADVAPI32.dll"
#func global BackupEventLogW "BackupEventLogW" wptr, wptr
; BackupEventLogW hEventLog, lpBackupFileName   ; 戻り値は stat
; hEventLog : HANDLE -> "wptr"
; lpBackupFileName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global BackupEventLogW "BackupEventLogW" sptr, wstr
; res = BackupEventLogW(hEventLog, lpBackupFileName)
; hEventLog : HANDLE -> "sptr"
; lpBackupFileName : LPCWSTR -> "wstr"
; BOOL BackupEventLogW(HANDLE hEventLog, LPCWSTR lpBackupFileName)
#uselib "ADVAPI32.dll"
#cfunc global BackupEventLogW "BackupEventLogW" intptr, wstr
; res = BackupEventLogW(hEventLog, lpBackupFileName)
; hEventLog : HANDLE -> "intptr"
; lpBackupFileName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procBackupEventLogW = advapi32.NewProc("BackupEventLogW")
)

// hEventLog (HANDLE), lpBackupFileName (LPCWSTR)
r1, _, err := procBackupEventLogW.Call(
	uintptr(hEventLog),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpBackupFileName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function BackupEventLogW(
  hEventLog: THandle;   // HANDLE
  lpBackupFileName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'BackupEventLogW';
result := DllCall("ADVAPI32\BackupEventLogW"
    , "Ptr", hEventLog   ; HANDLE
    , "WStr", lpBackupFileName   ; LPCWSTR
    , "Int")   ; return: BOOL
●BackupEventLogW(hEventLog, lpBackupFileName) = DLL("ADVAPI32.dll", "bool BackupEventLogW(void*, char*)")
# 呼び出し: BackupEventLogW(hEventLog, lpBackupFileName)
# hEventLog : HANDLE -> "void*"
# lpBackupFileName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "advapi32" fn BackupEventLogW(
    hEventLog: ?*anyopaque, // HANDLE
    lpBackupFileName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc BackupEventLogW(
    hEventLog: pointer,  # HANDLE
    lpBackupFileName: WideCString  # LPCWSTR
): int32 {.importc: "BackupEventLogW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "advapi32");
extern(Windows)
int BackupEventLogW(
    void* hEventLog,   // HANDLE
    const(wchar)* lpBackupFileName   // LPCWSTR
);
ccall((:BackupEventLogW, "ADVAPI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring),
      hEventLog, lpBackupFileName)
# hEventLog : HANDLE -> Ptr{Cvoid}
# lpBackupFileName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t BackupEventLogW(
    void* hEventLog,
    const uint16_t* lpBackupFileName);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.BackupEventLogW(hEventLog, lpBackupFileName)
-- hEventLog : HANDLE
-- lpBackupFileName : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const BackupEventLogW = lib.func('__stdcall', 'BackupEventLogW', 'int32_t', ['void *', 'str16']);
// BackupEventLogW(hEventLog, lpBackupFileName)
// hEventLog : HANDLE -> 'void *'
// lpBackupFileName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  BackupEventLogW: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.BackupEventLogW(hEventLog, lpBackupFileName)
// hEventLog : HANDLE -> "pointer"
// lpBackupFileName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BackupEventLogW(
    void* hEventLog,
    const uint16_t* lpBackupFileName);
C, "ADVAPI32.dll");
// $ffi->BackupEventLogW(hEventLog, lpBackupFileName);
// hEventLog : HANDLE
// lpBackupFileName : LPCWSTR
// 構造体/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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean BackupEventLogW(
        Pointer hEventLog,   // HANDLE
        WString lpBackupFileName   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("advapi32")]
lib LibADVAPI32
  fun BackupEventLogW = BackupEventLogW(
    hEventLog : Void*,   # HANDLE
    lpBackupFileName : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef BackupEventLogWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>);
typedef BackupEventLogWDart = int Function(Pointer<Void>, Pointer<Utf16>);
final BackupEventLogW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<BackupEventLogWNative, BackupEventLogWDart>('BackupEventLogW');
// hEventLog : HANDLE -> Pointer<Void>
// lpBackupFileName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BackupEventLogW(
  hEventLog: THandle;   // HANDLE
  lpBackupFileName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'BackupEventLogW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BackupEventLogW"
  c_BackupEventLogW :: Ptr () -> CWString -> IO CInt
-- hEventLog : HANDLE -> Ptr ()
-- lpBackupFileName : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let backupeventlogw =
  foreign "BackupEventLogW"
    ((ptr void) @-> (ptr uint16_t) @-> returning int32_t)
(* hEventLog : HANDLE -> (ptr void) *)
(* lpBackupFileName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("BackupEventLogW" backup-event-log-w :convention :stdcall) :int32
  (h-event-log :pointer)   ; HANDLE
  (lp-backup-file-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BackupEventLogW = Win32::API::More->new('ADVAPI32',
    'BOOL BackupEventLogW(HANDLE hEventLog, LPCWSTR lpBackupFileName)');
# my $ret = $BackupEventLogW->Call($hEventLog, $lpBackupFileName);
# hEventLog : HANDLE -> HANDLE
# lpBackupFileName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目