ホーム › System.EventLog › BackupEventLogA
BackupEventLogA
関数イベントログをファイルにバックアップする(ANSI版)。
シグネチャ
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
BOOL BackupEventLogA(
HANDLE hEventLog,
LPCSTR lpBackupFileName
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hEventLog | HANDLE | in | 開いているイベントログへのハンドル。このハンドルは OpenEventLog 関数が返します。 |
| lpBackupFileName | LPCSTR | in | バックアップファイルの絶対パスまたは相対パス。 |
戻り値の型: BOOL
公式ドキュメント
指定したイベントログをバックアップファイルに保存します。(ANSI)
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。
解説(Remarks)
ユーザーが SE_BACKUP_NAME 権限を持っていない場合、BackupEventLog 関数は ERROR_PRIVILEGE_NOT_HELD エラーで失敗します。
メモ
winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして BackupEventLog を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在して使用すると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// ADVAPI32.dll (ANSI / -A)
#include <windows.h>
BOOL BackupEventLogA(
HANDLE hEventLog,
LPCSTR lpBackupFileName
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool BackupEventLogA(
IntPtr hEventLog, // HANDLE
[MarshalAs(UnmanagedType.LPStr)] string lpBackupFileName // LPCSTR
);<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BackupEventLogA(
hEventLog As IntPtr, ' HANDLE
<MarshalAs(UnmanagedType.LPStr)> lpBackupFileName As String ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hEventLog : HANDLE
' lpBackupFileName : LPCSTR
Declare PtrSafe Function BackupEventLogA Lib "advapi32" ( _
ByVal hEventLog As LongPtr, _
ByVal lpBackupFileName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
BackupEventLogA = ctypes.windll.advapi32.BackupEventLogA
BackupEventLogA.restype = wintypes.BOOL
BackupEventLogA.argtypes = [
wintypes.HANDLE, # hEventLog : HANDLE
wintypes.LPCSTR, # lpBackupFileName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('ADVAPI32.dll')
BackupEventLogA = Fiddle::Function.new(
lib['BackupEventLogA'],
[
Fiddle::TYPE_VOIDP, # hEventLog : HANDLE
Fiddle::TYPE_VOIDP, # lpBackupFileName : LPCSTR
],
Fiddle::TYPE_INT)#[link(name = "advapi32")]
extern "system" {
fn BackupEventLogA(
hEventLog: *mut core::ffi::c_void, // HANDLE
lpBackupFileName: *const u8 // LPCSTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool BackupEventLogA(IntPtr hEventLog, [MarshalAs(UnmanagedType.LPStr)] string lpBackupFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_BackupEventLogA' -Namespace Win32 -PassThru
# $api::BackupEventLogA(hEventLog, lpBackupFileName)#uselib "ADVAPI32.dll"
#func global BackupEventLogA "BackupEventLogA" sptr, sptr
; BackupEventLogA hEventLog, lpBackupFileName ; 戻り値は stat
; hEventLog : HANDLE -> "sptr"
; lpBackupFileName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "ADVAPI32.dll"
#cfunc global BackupEventLogA "BackupEventLogA" sptr, str
; res = BackupEventLogA(hEventLog, lpBackupFileName)
; hEventLog : HANDLE -> "sptr"
; lpBackupFileName : LPCSTR -> "str"; BOOL BackupEventLogA(HANDLE hEventLog, LPCSTR lpBackupFileName)
#uselib "ADVAPI32.dll"
#cfunc global BackupEventLogA "BackupEventLogA" intptr, str
; res = BackupEventLogA(hEventLog, lpBackupFileName)
; hEventLog : HANDLE -> "intptr"
; lpBackupFileName : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
procBackupEventLogA = advapi32.NewProc("BackupEventLogA")
)
// hEventLog (HANDLE), lpBackupFileName (LPCSTR)
r1, _, err := procBackupEventLogA.Call(
uintptr(hEventLog),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpBackupFileName))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction BackupEventLogA(
hEventLog: THandle; // HANDLE
lpBackupFileName: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'BackupEventLogA';result := DllCall("ADVAPI32\BackupEventLogA"
, "Ptr", hEventLog ; HANDLE
, "AStr", lpBackupFileName ; LPCSTR
, "Int") ; return: BOOL●BackupEventLogA(hEventLog, lpBackupFileName) = DLL("ADVAPI32.dll", "bool BackupEventLogA(void*, char*)")
# 呼び出し: BackupEventLogA(hEventLog, lpBackupFileName)
# hEventLog : HANDLE -> "void*"
# lpBackupFileName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "advapi32" fn BackupEventLogA(
hEventLog: ?*anyopaque, // HANDLE
lpBackupFileName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;proc BackupEventLogA(
hEventLog: pointer, # HANDLE
lpBackupFileName: cstring # LPCSTR
): int32 {.importc: "BackupEventLogA", stdcall, dynlib: "ADVAPI32.dll".}pragma(lib, "advapi32");
extern(Windows)
int BackupEventLogA(
void* hEventLog, // HANDLE
const(char)* lpBackupFileName // LPCSTR
);ccall((:BackupEventLogA, "ADVAPI32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Cstring),
hEventLog, lpBackupFileName)
# hEventLog : HANDLE -> Ptr{Cvoid}
# lpBackupFileName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t BackupEventLogA(
void* hEventLog,
const char* lpBackupFileName);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.BackupEventLogA(hEventLog, lpBackupFileName)
-- hEventLog : HANDLE
-- lpBackupFileName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const BackupEventLogA = lib.func('__stdcall', 'BackupEventLogA', 'int32_t', ['void *', 'str']);
// BackupEventLogA(hEventLog, lpBackupFileName)
// hEventLog : HANDLE -> 'void *'
// lpBackupFileName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("ADVAPI32.dll", {
BackupEventLogA: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.BackupEventLogA(hEventLog, lpBackupFileName)
// hEventLog : HANDLE -> "pointer"
// lpBackupFileName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t BackupEventLogA(
void* hEventLog,
const char* lpBackupFileName);
C, "ADVAPI32.dll");
// $ffi->BackupEventLogA(hEventLog, lpBackupFileName);
// hEventLog : HANDLE
// lpBackupFileName : LPCSTR
// 構造体/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.ASCII_OPTIONS);
boolean BackupEventLogA(
Pointer hEventLog, // HANDLE
String lpBackupFileName // LPCSTR
);
}@[Link("advapi32")]
lib LibADVAPI32
fun BackupEventLogA = BackupEventLogA(
hEventLog : Void*, # HANDLE
lpBackupFileName : UInt8* # LPCSTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef BackupEventLogANative = Int32 Function(Pointer<Void>, Pointer<Utf8>);
typedef BackupEventLogADart = int Function(Pointer<Void>, Pointer<Utf8>);
final BackupEventLogA = DynamicLibrary.open('ADVAPI32.dll')
.lookupFunction<BackupEventLogANative, BackupEventLogADart>('BackupEventLogA');
// hEventLog : HANDLE -> Pointer<Void>
// lpBackupFileName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function BackupEventLogA(
hEventLog: THandle; // HANDLE
lpBackupFileName: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'ADVAPI32.dll' name 'BackupEventLogA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "BackupEventLogA"
c_BackupEventLogA :: Ptr () -> CString -> IO CInt
-- hEventLog : HANDLE -> Ptr ()
-- lpBackupFileName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let backupeventloga =
foreign "BackupEventLogA"
((ptr void) @-> string @-> returning int32_t)
(* hEventLog : HANDLE -> (ptr void) *)
(* lpBackupFileName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)
(cffi:defcfun ("BackupEventLogA" backup-event-log-a :convention :stdcall) :int32
(h-event-log :pointer) ; HANDLE
(lp-backup-file-name :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $BackupEventLogA = Win32::API::More->new('ADVAPI32',
'BOOL BackupEventLogA(HANDLE hEventLog, LPCSTR lpBackupFileName)');
# my $ret = $BackupEventLogA->Call($hEventLog, $lpBackupFileName);
# hEventLog : HANDLE -> HANDLE
# lpBackupFileName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f BackupEventLogW (Unicode版) — イベントログをファイルにバックアップする(Unicode版)。
公式の関連項目
- f OpenBackupEventLogA — バックアップ済みイベントログを開く(ANSI版)。
- f OpenEventLogA — 指定したイベントログを開く(ANSI版)。