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
)
public void DeleteSubKeyTree (
	String subkey
)
public function DeleteSubKeyTree (
	subkey : String
)

Parameters

subkey

The subkey to delete.

Exception typeCondition

ArgumentNullException

subkey is a null reference (Nothing in Visual Basic).

ArgumentException

Deletion of a root hive is attempted.

-or-

subkey does not specify a valid registry subkey.

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 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0
Show: