WindowsUtilitiesRename Method |
Renames the specified registry key.
Namespace: ShellBoost.Core.Utilities
Assembly: ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
SyntaxC#
public static int Rename( this RegistryKey key, string oldName, string newName, bool throwOnError = true )
Parameters
- key
- Type: Microsoft.Win32RegistryKey
The registry key. - oldName
- Type: SystemString
The old name. - newName
- Type: SystemString
The new name. - throwOnError (Optional)
- Type: SystemBoolean
true to throw error; otherwise false.
Return Value
Type: Int32An error or 0 if operation was successful.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type RegistryKey. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).Exceptions| Exception | Condition |
|---|---|
| ArgumentNullException | oldName is null or newName is null. |
| ArgumentException | key has an invalid handle. |
See Also