RegistryKey.DeleteSubKeyTree Method (String, Boolean)

.NET Framework (current version)
 

Deletes the specified subkey and any child subkeys recursively, and specifies whether an exception is raised if the subkey is not found.

Namespace:   Microsoft.Win32
Assembly:  mscorlib (in mscorlib.dll)

[ComVisibleAttribute(false)]
public void DeleteSubKeyTree(
	string subkey,
	bool throwOnMissingSubKey
)

Parameters

subkey
Type: System.String

The name of the subkey to delete. This string is not case-sensitive.

throwOnMissingSubKey
Type: System.Boolean

Indicates whether an exception should be raised if the specified subkey cannot be found. If this argument is true and the specified subkey does not exist, an exception is raised. If this argument is false and the specified subkey does not exist, no action is taken.

Exception Condition
ArgumentException

An attempt was made to delete the root hive of the tree.

-or-

subkey does not specify a valid registry subkey, and throwOnMissingSubKey is true.

ArgumentNullException

subkey is null.

ObjectDisposedException

The RegistryKey is closed (closed keys cannot be accessed).

UnauthorizedAccessException

The user does not have the necessary registry rights.

SecurityException

The user does not have the permissions required to delete the key.

RegistryPermission

for the ability to modify the specified registry key. Associated enumeration: RegistryPermissionAccess.Write

SecurityPermission

for the ability to access the specified registry key if it is a remote key. Associated enumeration: SecurityPermissionFlag.UnmanagedCode

.NET Framework
Available since 4.0
Return to top
Show: