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

OpenBackupEventLogA

関数
バックアップ済みイベントログを開く(ANSI版)。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

HANDLE OpenBackupEventLogA(
    LPCSTR lpUNCServerName,   // optional
    LPCSTR lpFileName
);

パラメーター

名前方向説明
lpUNCServerNameLPCSTRinoptionalこの操作を実行するリモートサーバーの汎用名前付け規則 (UNC) 名。このパラメーターが NULL の場合、ローカルコンピューターが使用されます。
lpFileNameLPCSTRinバックアップファイルのフルパス。

戻り値の型: HANDLE

公式ドキュメント

BackupEventLog 関数によって作成されたバックアップイベントログへのハンドルを開きます。(ANSI)

戻り値

関数が成功した場合、戻り値はバックアップイベントログへのハンドルです。

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

バックアップファイル名がリモートサーバーを指定している場合、lpUNCServerName パラメーターは NULL でなければなりません。

この関数を Windows Vista 以降のコンピューターで使用する場合、Windows Vista 以降のコンピューターで BackupEventLog 関数を使用して保存されたバックアップイベントログのみを開くことができます。

メモ

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

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

HANDLE OpenBackupEventLogA(
    LPCSTR lpUNCServerName,   // optional
    LPCSTR lpFileName
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr OpenBackupEventLogA(
    [MarshalAs(UnmanagedType.LPStr)] string lpUNCServerName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName   // LPCSTR
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenBackupEventLogA(
    <MarshalAs(UnmanagedType.LPStr)> lpUNCServerName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String   ' LPCSTR
) As IntPtr
End Function
' lpUNCServerName : LPCSTR optional
' lpFileName : LPCSTR
Declare PtrSafe Function OpenBackupEventLogA Lib "advapi32" ( _
    ByVal lpUNCServerName As String, _
    ByVal lpFileName As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OpenBackupEventLogA = ctypes.windll.advapi32.OpenBackupEventLogA
OpenBackupEventLogA.restype = ctypes.c_void_p
OpenBackupEventLogA.argtypes = [
    wintypes.LPCSTR,  # lpUNCServerName : LPCSTR optional
    wintypes.LPCSTR,  # lpFileName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
OpenBackupEventLogA = Fiddle::Function.new(
  lib['OpenBackupEventLogA'],
  [
    Fiddle::TYPE_VOIDP,  # lpUNCServerName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "advapi32")]
extern "system" {
    fn OpenBackupEventLogA(
        lpUNCServerName: *const u8,  // LPCSTR optional
        lpFileName: *const u8  // LPCSTR
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr OpenBackupEventLogA([MarshalAs(UnmanagedType.LPStr)] string lpUNCServerName, [MarshalAs(UnmanagedType.LPStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_OpenBackupEventLogA' -Namespace Win32 -PassThru
# $api::OpenBackupEventLogA(lpUNCServerName, lpFileName)
#uselib "ADVAPI32.dll"
#func global OpenBackupEventLogA "OpenBackupEventLogA" sptr, sptr
; OpenBackupEventLogA lpUNCServerName, lpFileName   ; 戻り値は stat
; lpUNCServerName : LPCSTR optional -> "sptr"
; lpFileName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global OpenBackupEventLogA "OpenBackupEventLogA" str, str
; res = OpenBackupEventLogA(lpUNCServerName, lpFileName)
; lpUNCServerName : LPCSTR optional -> "str"
; lpFileName : LPCSTR -> "str"
; HANDLE OpenBackupEventLogA(LPCSTR lpUNCServerName, LPCSTR lpFileName)
#uselib "ADVAPI32.dll"
#cfunc global OpenBackupEventLogA "OpenBackupEventLogA" str, str
; res = OpenBackupEventLogA(lpUNCServerName, lpFileName)
; lpUNCServerName : LPCSTR optional -> "str"
; lpFileName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procOpenBackupEventLogA = advapi32.NewProc("OpenBackupEventLogA")
)

// lpUNCServerName (LPCSTR optional), lpFileName (LPCSTR)
r1, _, err := procOpenBackupEventLogA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpUNCServerName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function OpenBackupEventLogA(
  lpUNCServerName: PAnsiChar;   // LPCSTR optional
  lpFileName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'ADVAPI32.dll' name 'OpenBackupEventLogA';
result := DllCall("ADVAPI32\OpenBackupEventLogA"
    , "AStr", lpUNCServerName   ; LPCSTR optional
    , "AStr", lpFileName   ; LPCSTR
    , "Ptr")   ; return: HANDLE
●OpenBackupEventLogA(lpUNCServerName, lpFileName) = DLL("ADVAPI32.dll", "void* OpenBackupEventLogA(char*, char*)")
# 呼び出し: OpenBackupEventLogA(lpUNCServerName, lpFileName)
# lpUNCServerName : LPCSTR optional -> "char*"
# lpFileName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn OpenBackupEventLogA(
    lpUNCServerName: [*c]const u8, // LPCSTR optional
    lpFileName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc OpenBackupEventLogA(
    lpUNCServerName: cstring,  # LPCSTR optional
    lpFileName: cstring  # LPCSTR
): pointer {.importc: "OpenBackupEventLogA", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
void* OpenBackupEventLogA(
    const(char)* lpUNCServerName,   // LPCSTR optional
    const(char)* lpFileName   // LPCSTR
);
ccall((:OpenBackupEventLogA, "ADVAPI32.dll"), stdcall, Ptr{Cvoid},
      (Cstring, Cstring),
      lpUNCServerName, lpFileName)
# lpUNCServerName : LPCSTR optional -> Cstring
# lpFileName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* OpenBackupEventLogA(
    const char* lpUNCServerName,
    const char* lpFileName);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.OpenBackupEventLogA(lpUNCServerName, lpFileName)
-- lpUNCServerName : LPCSTR optional
-- lpFileName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const OpenBackupEventLogA = lib.func('__stdcall', 'OpenBackupEventLogA', 'void *', ['str', 'str']);
// OpenBackupEventLogA(lpUNCServerName, lpFileName)
// lpUNCServerName : LPCSTR optional -> 'str'
// lpFileName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  OpenBackupEventLogA: { parameters: ["buffer", "buffer"], result: "pointer" },
});
// lib.symbols.OpenBackupEventLogA(lpUNCServerName, lpFileName)
// lpUNCServerName : LPCSTR optional -> "buffer"
// lpFileName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* OpenBackupEventLogA(
    const char* lpUNCServerName,
    const char* lpFileName);
C, "ADVAPI32.dll");
// $ffi->OpenBackupEventLogA(lpUNCServerName, lpFileName);
// lpUNCServerName : LPCSTR optional
// lpFileName : 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);
    Pointer OpenBackupEventLogA(
        String lpUNCServerName,   // LPCSTR optional
        String lpFileName   // LPCSTR
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun OpenBackupEventLogA = OpenBackupEventLogA(
    lpUNCServerName : UInt8*,   # LPCSTR optional
    lpFileName : UInt8*   # LPCSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef OpenBackupEventLogANative = Pointer<Void> Function(Pointer<Utf8>, Pointer<Utf8>);
typedef OpenBackupEventLogADart = Pointer<Void> Function(Pointer<Utf8>, Pointer<Utf8>);
final OpenBackupEventLogA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<OpenBackupEventLogANative, OpenBackupEventLogADart>('OpenBackupEventLogA');
// lpUNCServerName : LPCSTR optional -> Pointer<Utf8>
// lpFileName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenBackupEventLogA(
  lpUNCServerName: PAnsiChar;   // LPCSTR optional
  lpFileName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'ADVAPI32.dll' name 'OpenBackupEventLogA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenBackupEventLogA"
  c_OpenBackupEventLogA :: CString -> CString -> IO (Ptr ())
-- lpUNCServerName : LPCSTR optional -> CString
-- lpFileName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let openbackupeventloga =
  foreign "OpenBackupEventLogA"
    (string @-> string @-> returning (ptr void))
(* lpUNCServerName : LPCSTR optional -> string *)
(* lpFileName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("OpenBackupEventLogA" open-backup-event-log-a :convention :stdcall) :pointer
  (lp-uncserver-name :string)   ; LPCSTR optional
  (lp-file-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenBackupEventLogA = Win32::API::More->new('ADVAPI32',
    'HANDLE OpenBackupEventLogA(LPCSTR lpUNCServerName, LPCSTR lpFileName)');
# my $ret = $OpenBackupEventLogA->Call($lpUNCServerName, $lpFileName);
# lpUNCServerName : LPCSTR optional -> LPCSTR
# lpFileName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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