Export (0) Print
Expand All

RegistryKey.DeleteSubKeyTree Method (String)

Deletes a subkey and any child subkeys recursively.

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

public void DeleteSubKeyTree(
	string subkey
)

Parameters

subkey
Type: System.String

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

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();
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft