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

RegRestoreKeyW

関数
保存済みハイブファイルから指定キーを復元する。
DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR RegRestoreKeyW(
    HKEY hKey,
    LPCWSTR lpFile,
    DWORD dwFlags
);

パラメーター

名前方向説明
hKeyHKEYin

オープン済みのレジストリキーのハンドルです。このハンドルは RegCreateKeyEx または RegOpenKeyEx 関数によって返されます。次のいずれかの定義済みキーを指定することもできます。

HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_USERS このキーおよびその子孫キーに含まれる情報は、lpFile パラメーターが指すファイル内の情報によって上書きされます。

lpFileLPCWSTRinレジストリ情報を含むファイルの名前です。このファイルは通常、 RegSaveKey 関数を使用して作成されます。
dwFlagsDWORDin

キーをどのように復元するかを示すフラグです。このパラメーターには、次のいずれかの値を指定できます。

意味
REG_FORCE_RESTORE
0x00000008L
指定すると、hKey パラメーターが指すレジストリ階層上の位置、またはその配下にオープン済みのハンドルが存在する場合でも、復元操作が実行されます。
REG_WHOLE_HIVE_VOLATILE
0x00000001L
指定すると、新しい揮発性 (メモリのみ) のレジストリ情報セット、すなわちハイブが作成されます。REG_WHOLE_HIVE_VOLATILE を指定する場合、hKey パラメーターで識別されるキーは HKEY_USERS または HKEY_LOCAL_MACHINE の値でなければなりません。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定されたファイル内のレジストリ情報を読み取り、指定されたキーへ上書きコピーします。このレジストリ情報は、1 つのキーと複数階層のサブキーの形式である場合があります。(Unicode)

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は Winerror.h で定義されている 0 以外のエラーコードです。 FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用すると、エラーの一般的な説明を取得できます。

解説(Remarks)

レジストリハイブのファイル形式には 2 種類があります。現在のオペレーティングシステムで作成されたレジストリハイブは、通常、それより古いオペレーティングシステムでは読み込めません。

hKey パラメーターのいずれかのサブキーがオープンされている場合、 RegRestoreKey は失敗します。

呼び出し元プロセスは、レジストリが存在するコンピューター上で SE_RESTORE_NAME および SE_BACKUP_NAME 特権を持っている必要があります。詳細については、 Running with Special Privileges を参照してください。

この関数は、ファイル内の最上位キーの名前にかかわらず、指定されたキーの配下にあるキーと値を、ファイル内の最上位キーに従属するキーと値で置き換えます。たとえば、hKey がサブキー B と C を持つキー A を識別し、lpFile パラメーターがサブキー Y と Z を持つキー X を含むファイルを指定しているとします。 RegRestoreKey の呼び出し後、レジストリにはサブキー Y と Z を持つキー A が含まれることになります。A の値エントリは X の値エントリで置き換えられます。

lpFile で指定されたファイル内の新しい情報は、キー名を除き、hKey パラメーターで指定されたキーの内容を上書きします。

hKey がリモートコンピューター上のキーを表す場合、lpFile で記述されるパスはそのリモートコンピューターからの相対パスになります。

メモ

winreg.h ヘッダーは RegRestoreKey を、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>

WIN32_ERROR RegRestoreKeyW(
    HKEY hKey,
    LPCWSTR lpFile,
    DWORD dwFlags
);
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint RegRestoreKeyW(
    IntPtr hKey,   // HKEY
    [MarshalAs(UnmanagedType.LPWStr)] string lpFile,   // LPCWSTR
    uint dwFlags   // DWORD
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RegRestoreKeyW(
    hKey As IntPtr,   ' HKEY
    <MarshalAs(UnmanagedType.LPWStr)> lpFile As String,   ' LPCWSTR
    dwFlags As UInteger   ' DWORD
) As UInteger
End Function
' hKey : HKEY
' lpFile : LPCWSTR
' dwFlags : DWORD
Declare PtrSafe Function RegRestoreKeyW Lib "advapi32" ( _
    ByVal hKey As LongPtr, _
    ByVal lpFile As LongPtr, _
    ByVal dwFlags As Long) 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

RegRestoreKeyW = ctypes.windll.advapi32.RegRestoreKeyW
RegRestoreKeyW.restype = wintypes.DWORD
RegRestoreKeyW.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCWSTR,  # lpFile : LPCWSTR
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegRestoreKeyW = advapi32.NewProc("RegRestoreKeyW")
)

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

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

typedef RegRestoreKeyWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Uint32);
typedef RegRestoreKeyWDart = int Function(Pointer<Void>, Pointer<Utf16>, int);
final RegRestoreKeyW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<RegRestoreKeyWNative, RegRestoreKeyWDart>('RegRestoreKeyW');
// hKey : HKEY -> Pointer<Void>
// lpFile : LPCWSTR -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegRestoreKeyW(
  hKey: THandle;   // HKEY
  lpFile: PWideChar;   // LPCWSTR
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'RegRestoreKeyW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegRestoreKeyW"
  c_RegRestoreKeyW :: Ptr () -> CWString -> Word32 -> IO Word32
-- hKey : HKEY -> Ptr ()
-- lpFile : LPCWSTR -> CWString
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let regrestorekeyw =
  foreign "RegRestoreKeyW"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* hKey : HKEY -> (ptr void) *)
(* lpFile : LPCWSTR -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

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

関連項目

文字セット違い
公式の関連項目
使用する型