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

RegReplaceKeyA

関数
指定キーのバックアップ用ファイルを置き換える。
DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR RegReplaceKeyA(
    HKEY hKey,
    LPCSTR lpSubKey,   // optional
    LPCSTR lpNewFile,
    LPCSTR lpOldFile
);

パラメーター

名前型方向説明
hKeyHKEYin

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

HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_USERS

lpSubKeyLPCSTRinoptional

サブキーと値を置き換える対象のレジストリキーの名前。キーが存在する場合、それは hKey パラメーターで識別されるキーのサブキーである必要があります。サブキーが存在しない場合は作成されます。このパラメーターには NULL を指定できます。

指定されたサブキーがハイブのルートでない場合、 RegReplaceKey はハイブのルートに到達するまでハイブのツリー構造をさかのぼり、そのハイブの内容を lpNewFile で指定されたデータファイルの内容で置き換えます。

詳細については、 レジストリ要素のサイズ制限 を参照してください。

lpNewFileLPCSTRinレジストリ情報を含むファイルの名前。このファイルは通常、 RegSaveKey 関数を使用して作成されます。
lpOldFileLPCSTRin置き換えられるレジストリ情報のバックアップコピーを受け取るファイルの名前。

戻り値の型: WIN32_ERROR

公式ドキュメント

レジストリキーとそのすべてのサブキーをバックアップしているファイルを別のファイルで置き換えます。これにより、次回システムが起動したときに、そのキーとサブキーは新しいファイルに格納された値を持つようになります。(ANSI)

戻り値

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

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

解説(Remarks)

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

lpNewFile パラメーターで指定されたファイルは、システムが再起動されるまでオープンされたままになります。

hKey が RegConnectRegistry によって返されたハンドルである場合、lpNewFile および lpOldFile で指定されたパスはリモートコンピューターからの相対パスになります。

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

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

RegReplaceKeyA = ctypes.windll.advapi32.RegReplaceKeyA
RegReplaceKeyA.restype = wintypes.DWORD
RegReplaceKeyA.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCSTR,  # lpSubKey : LPCSTR optional
    wintypes.LPCSTR,  # lpNewFile : LPCSTR
    wintypes.LPCSTR,  # lpOldFile : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegReplaceKeyA = advapi32.NewProc("RegReplaceKeyA")
)

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

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

typedef RegReplaceKeyANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
typedef RegReplaceKeyADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
final RegReplaceKeyA = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<RegReplaceKeyANative, RegReplaceKeyADart>('RegReplaceKeyA');
// hKey : HKEY -> Pointer<Void>
// lpSubKey : LPCSTR optional -> Pointer<Utf8>
// lpNewFile : LPCSTR -> Pointer<Utf8>
// lpOldFile : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegReplaceKeyA(
  hKey: THandle;   // HKEY
  lpSubKey: PAnsiChar;   // LPCSTR optional
  lpNewFile: PAnsiChar;   // LPCSTR
  lpOldFile: PAnsiChar   // LPCSTR
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'RegReplaceKeyA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegReplaceKeyA"
  c_RegReplaceKeyA :: Ptr () -> CString -> CString -> CString -> IO Word32
-- hKey : HKEY -> Ptr ()
-- lpSubKey : LPCSTR optional -> CString
-- lpNewFile : LPCSTR -> CString
-- lpOldFile : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("RegReplaceKeyA" reg-replace-key-a :convention :stdcall) :uint32
  (h-key :pointer)   ; HKEY
  (lp-sub-key :string)   ; LPCSTR optional
  (lp-new-file :string)   ; LPCSTR
  (lp-old-file :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegReplaceKeyA = Win32::API::More->new('ADVAPI32',
    'DWORD RegReplaceKeyA(HANDLE hKey, LPCSTR lpSubKey, LPCSTR lpNewFile, LPCSTR lpOldFile)');
# my $ret = $RegReplaceKeyA->Call($hKey, $lpSubKey, $lpNewFile, $lpOldFile);
# hKey : HKEY -> HANDLE
# lpSubKey : LPCSTR optional -> LPCSTR
# lpNewFile : LPCSTR -> LPCSTR
# lpOldFile : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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