Export (0) Print
Expand All

RegistryKey.DeleteSubKeyTree Method (String, Boolean)

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.

ExceptionCondition
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.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft