This documentation is archived and is not being maintained.

RegistryKey.DeleteSubKeyTree Method

Deletes a subkey and any child subkeys recursively. The string subkey is not case-sensitive.

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

public void DeleteSubKeyTree(
	string subkey
)

Parameters

subkey
Type: System.String

The subkey to delete.

ExceptionCondition
ArgumentNullException

subkey is null.

ArgumentException

Deletion of a root hive is attempted.

-or-

subkey does not specify a valid registry subkey.

IOException

An I/O error has occurred.

SecurityException

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

ObjectDisposedException

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

UnauthorizedAccessException

The user does not have the necessary registry rights.

You must have appropriate permissions to delete the subkey and its tree.

Caution noteCaution:

Deleting a particular key will remove all entries below the key in the tree. No warning will be provided. If you want to delete a subkey only when it has no child subkeys, use the DeleteSubKey method.

This code example is part of a larger example provided for the RegistryKey class.

// Delete or close the new subkey.
Console.Write("\nDelete newly created registry key? (Y/N) ");
if(Char.ToUpper(Convert.ToChar(Console.Read())) == 'Y')
{
    Registry.CurrentUser.DeleteSubKeyTree("Test9999");
    Console.WriteLine("\nRegistry key {0} deleted.", 
        test9999.Name);
}
else
{
    Console.WriteLine("\nRegistry key {0} closed.", 
        test9999.ToString());
    test9999.Close();
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0
Show: