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

OpenBackupEventLogW

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

シグネチャ

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

HANDLE OpenBackupEventLogW(
    LPCWSTR lpUNCServerName,   // optional
    LPCWSTR lpFileName
);

パラメーター

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

戻り値の型: HANDLE

公式ドキュメント

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

戻り値

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

関数が失敗した場合、戻り値は 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  (Unicode / -W)
#include <windows.h>

HANDLE OpenBackupEventLogW(
    LPCWSTR lpUNCServerName,   // optional
    LPCWSTR lpFileName
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr OpenBackupEventLogW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpUNCServerName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName   // LPCWSTR
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenBackupEventLogW(
    <MarshalAs(UnmanagedType.LPWStr)> lpUNCServerName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String   ' LPCWSTR
) As IntPtr
End Function
' lpUNCServerName : LPCWSTR optional
' lpFileName : LPCWSTR
Declare PtrSafe Function OpenBackupEventLogW Lib "advapi32" ( _
    ByVal lpUNCServerName As LongPtr, _
    ByVal lpFileName As LongPtr) As LongPtr
' 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

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

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procOpenBackupEventLogW = advapi32.NewProc("OpenBackupEventLogW")
)

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

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

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

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

let openbackupeventlogw =
  foreign "OpenBackupEventLogW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> returning (ptr void))
(* lpUNCServerName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpFileName : 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 ("OpenBackupEventLogW" open-backup-event-log-w :convention :stdcall) :pointer
  (lp-uncserver-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-file-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenBackupEventLogW = Win32::API::More->new('ADVAPI32',
    'HANDLE OpenBackupEventLogW(LPCWSTR lpUNCServerName, LPCWSTR lpFileName)');
# my $ret = $OpenBackupEventLogW->Call($lpUNCServerName, $lpFileName);
# lpUNCServerName : LPCWSTR optional -> LPCWSTR
# lpFileName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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