Show/Hide TOC

AdvApi32RegRenameKey(SafeRegistryHandle, String, String) Method

Renames a registry subkey.

Definition

Namespace: DevCase.Win32.NativeMethods
Assembly: DevCase.net48 (in DevCase.net48.dll) Version: 6.0.0.0 (6.0)
XMLNS for XAML: Not mapped to an xmlns.

C#Request Example

[DllImportAttribute("AdvApi32.dll", CharSet = CharSet.Auto, BestFitMapping = false, 
	ThrowOnUnmappableChar = true, SetLastError = true)]
public static Win32ErrorCode RegRenameKey(
	SafeRegistryHandle hKey,
	string srcSubKeyPathOrName,
	string dstSubkeyName
)

VBRequest Example

<DllImportAttribute("AdvApi32.dll", CharSet := CharSet.Auto, BestFitMapping := false, 
	ThrowOnUnmappableChar := true, SetLastError := true>]
Public Shared Function RegRenameKey ( 
	hKey As SafeRegistryHandle,
	srcSubKeyPathOrName As String,
	dstSubkeyName As String
) As Win32ErrorCode

Dim hKey As SafeRegistryHandle
Dim srcSubKeyPathOrName As String
Dim dstSubkeyName As String

Dim returnValue As Win32ErrorCode

returnValue = AdvApi32.RegRenameKey(hKey, 
	srcSubKeyPathOrName, dstSubkeyName)

C++Request Example

public:
[DllImportAttribute(L"AdvApi32.dll", CharSet = CharSet::Auto, BestFitMapping = false, 
	ThrowOnUnmappableChar = true, SetLastError = true)]
static Win32ErrorCode RegRenameKey(
	SafeRegistryHandle^ hKey, 
	String^ srcSubKeyPathOrName, 
	String^ dstSubkeyName
)

F#Request Example

[<DllImportAttribute("AdvApi32.dll", CharSet = CharSet.Auto, BestFitMapping = false, 
	ThrowOnUnmappableChar = true, SetLastError = true)>]
static member RegRenameKey : 
        hKey : SafeRegistryHandle * 
        srcSubKeyPathOrName : string * 
        dstSubkeyName : string -> Win32ErrorCode

ASP.NETRequest Example

No code example is currently available or this language may not be supported.

Parameters

hKey SafeRegistryHandle: A handle to the source registry rootkey or subkey.
srcSubKeyPathOrName String: The relative path or the name of the source subkey. (eg. "SOFTWARE\My Old SubKey" or "My Old SubKey")
dstSubkeyName String: The destination name of the subkey. (eg. "My New SubKey")

Return Value

Win32ErrorCode
Returns 0 (zero) if successful; otherwise, a Win32 system error code.

Remarks

This function is not documented, but it internaly calls NtRenameKey function:

https://msdn.microsoft.com/en-us/library/cc512138.aspx

Example

This is a code example.

C#

No code example is currently available or this language may not be supported.

VB

Using regKey As RegistryKey =
    RegistryKey.OpenBaseKey(RegistryHive.LocalMachine, RegistryView.Registry64).
                OpenSubKey("SOFTWARE", RegistryKeyPermissionCheck.ReadWriteSubTree)

    Dim result As Integer = NativeMethods.RegRenameKey(regKey.Handle, "Old SubKey Name", "New SubKey Name")

    If (result <> 0) Then
        Throw New Win32Exception(result)
    End If

End Using

C++

No code example is currently available or this language may not be supported.

F#

No code example is currently available or this language may not be supported.

XAML

No code example is currently available or this language may not be supported.

ASP.NET

No code example is currently available or this language may not be supported.