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

RegRenameKey

関数
指定したレジストリのサブキーの名前を変更する。
DLLADVAPI32.dll呼出規約winapi

シグネチャ

// ADVAPI32.dll
#include <windows.h>

WIN32_ERROR RegRenameKey(
    HKEY hKey,
    LPCWSTR lpSubKeyName,   // optional
    LPCWSTR lpNewKeyName
);

パラメーター

名前方向説明
hKeyHKEYin

名前を変更するキーへのハンドル。このハンドルは KEY_WRITE アクセス権で開かれている必要があります。詳細については、レジストリキーのセキュリティとアクセス権を参照してください。

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

lpSubKeyNameLPCWSTRinoptional名前を変更するサブキーの名前。このキーは、hKey パラメーターで識別されるキーのサブキーである必要があります。このパラメーターには NULL を指定することもでき、その場合は hKey パラメーターで識別されるキー自体の名前が変更されます。
lpNewKeyNameLPCWSTRinキーの新しい名前。新しい名前は、既に存在していてはなりません。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定されたレジストリキーの名前を変更します。(RegRenameKey)

戻り値

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

関数が失敗した場合、戻り値は Winerror.h で定義されている 0 以外のエラーコードです。FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグとともに使用すると、エラーの一般的な説明を取得できます。STATUS_ACCESS_DENIED というエラーコードは、呼び出し元が指定されたレジストリキーまたはサブキーに対する必要なアクセス権を持っていないことを示します。

解説(Remarks)

この関数は、レジストリのサブツリー全体の名前を変更するために使用できます。呼び出し元は、指定されたキーの親に対する KEY_CREATE_SUB_KEY アクセス権と、名前を変更するサブツリー全体に対する DELETE アクセス権を持っている必要があります。

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

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

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

RegRenameKey = ctypes.windll.advapi32.RegRenameKey
RegRenameKey.restype = wintypes.DWORD
RegRenameKey.argtypes = [
    wintypes.HANDLE,  # hKey : HKEY
    wintypes.LPCWSTR,  # lpSubKeyName : LPCWSTR optional
    wintypes.LPCWSTR,  # lpNewKeyName : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procRegRenameKey = advapi32.NewProc("RegRenameKey")
)

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

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

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

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

let regrenamekey =
  foreign "RegRenameKey"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* hKey : HKEY -> (ptr void) *)
(* lpSubKeyName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpNewKeyName : 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 ("RegRenameKey" reg-rename-key :convention :stdcall) :uint32
  (h-key :pointer)   ; HKEY
  (lp-sub-key-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-new-key-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegRenameKey = Win32::API::More->new('ADVAPI32',
    'DWORD RegRenameKey(HANDLE hKey, LPCWSTR lpSubKeyName, LPCWSTR lpNewKeyName)');
# my $ret = $RegRenameKey->Call($hKey, $lpSubKeyName, $lpNewKeyName);
# hKey : HKEY -> HANDLE
# lpSubKeyName : LPCWSTR optional -> LPCWSTR
# lpNewKeyName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型