RegistryRename (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

RegistryRename (Function)

In french: RegistreRenomme

Renames a key and/or a value in the registry.

Remark: Renaming a key consists in:

Copying the key.
Renaming the copied key.
Deleting the former key.

Example

// Renames the "MyApp" key to "MyApplication"
RegistryRename("HKEY_LOCAL_MACHINE\SOFTWARE\MyApp", ...
"HKEY_LOCAL_MACHINE\SOFTWARE\MyApplication")

// Renames the "Auto" value to "Automatic"
RegistryRename("HKEY_LOCAL_MACHINE\SOFTWARE\MyApp", "Auto", "Automatic")

Syntax

Renaming a key in the registry Hide the details

<Result> = RegistryRename(<Name of key to rename> , <New key name>)

<Result>: Boolean

True if the rename operation was performed,
False otherwise.

<Name of key to rename>: Character string (with quotes)

Full path of the key to rename. <Result> will return False if this key does not exist.

<New key name>: Character string (with quotes)

New path and name of the key. <Result> will return False if this key already exists.

Renaming a registry key as well as its value Hide the details

<Result> = RegistryRename(<Name of key to rename> , <Name of value to rename> [, <New key name>] , <New value name>)

<Result>: Boolean

True if the rename operation was performed,
False otherwise.

<Name of key to rename>: Character string (with quotes)

Full path of the key to rename. <Result> will return False if this key does not exist.

<Name of value to rename>: Character string (with quotes)

Name of the value to rename in the registry for the specified key. <Result> will return False if this value does not exist.

<New key name>: Optional character string (with quotes)

New path and name of the key. If this parameter corresponds to an empty string ("") or is not specified, the name of the key is not modified. <Result> will return False if this key already exists.

<New value name>: Character string (with quotes)

New name of the value in the registry for the specified key.

Remarks

RegistryRename performs a recursive copy then a recursive deletion.
From Windows Vista and later, the operations linked to the renaming are performed in a transaction. If an operation fails, all the previous operations are canceled.
In earlier versions of Windows, the operations linked to the renaming are not performed in transaction. If an operation fails (deletion of a key for example), the previous operations (copy of the key for example) are not canceled.

Business / UI classification : Business Logic

Component : wd260std.dll