RegistryKey.DeleteSubKeyTree Método

Definição

Namespace:

Microsoft.Win32

Assembly:

Microsoft.Win32.Registry.dll

Exclui uma subchave e qualquer subchave filho recursivamente, com tratamento opcional de exceção.

Sobrecargas

DeleteSubKeyTree(String, Boolean)	Exclui a subchave especificada e todas as subchaves filho recursivamente e especifica se uma exceção é gerada se a subchave não for encontrada.
DeleteSubKeyTree(String)	Exclui uma subchave e qualquer subchave filho recursivamente.

DeleteSubKeyTree(String, Boolean)

Exclui a subchave especificada e todas as subchaves filho recursivamente e especifica se uma exceção é gerada se a subchave não for encontrada.

public:
 void DeleteSubKeyTree(System::String ^ subkey, bool throwOnMissingSubKey);

public void DeleteSubKeyTree (string subkey, bool throwOnMissingSubKey);

member this.DeleteSubKeyTree : string * bool -> unit

Public Sub DeleteSubKeyTree (subkey As String, throwOnMissingSubKey As Boolean)

Parâmetros

subkey

String

O nome da subchave a ser excluída. Essa cadeia de caracteres não diferencia maiúsculas de minúsculas.

throwOnMissingSubKey

Boolean

Indica se uma exceção deve ser gerada se a subchave especificada não puder ser encontrada. Se esse argumento for true e a subchave especificada não existir, uma exceção será gerada. Se esse argumento for false e a subchave especificada não existir, nenhuma ação será tomada.

Exceções

ArgumentException

Foi feita uma tentativa de excluir o hive raiz da árvore.

-ou-

subkey não especifica uma subchave válida do Registro e throwOnMissingSubKey é true.

ArgumentNullException

subkey é null.

ObjectDisposedException

O RegistryKey está fechado (as chaves fechadas não podem ser acessadas).

UnauthorizedAccessException

O usuário não tem os direitos de registro necessários.

SecurityException

O usuário não tem as permissões necessárias para excluir a chave.

DeleteSubKeyTree(String)

Exclui uma subchave e qualquer subchave filho recursivamente.

public:
 void DeleteSubKeyTree(System::String ^ subkey);

public void DeleteSubKeyTree (string subkey);

member this.DeleteSubKeyTree : string -> unit

Public Sub DeleteSubKeyTree (subkey As String)

Parâmetros

subkey

String

A subchave a ser excluída. Essa cadeia de caracteres não diferencia maiúsculas de minúsculas.

Exceções

ArgumentNullException

subkey é null.

ArgumentException

Tentativa de exclusão de um hive raiz.

-ou-

subkey não especifica uma subchave válida do Registro.

IOException

Ocorreu um erro de E/S.

SecurityException

O usuário não tem as permissões necessárias para excluir a chave.

ObjectDisposedException

O RegistryKey que está sendo manipulado é fechado (chaves fechadas não podem ser acessadas).

UnauthorizedAccessException

O usuário não tem os direitos de registro necessários.

Exemplos

Este exemplo de código faz parte de um exemplo maior fornecido para a classe RegistryKey.

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

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

' Delete or close the new subkey.
Console.Write(vbCrLf & "Delete newly created " & _
    "registry key? (Y/N) ")
If Char.ToUpper(Convert.ToChar(Console.Read())) = "Y"C Then
    Registry.CurrentUser.DeleteSubKeyTree("Test9999")
    Console.WriteLine(vbCrLf & "Registry key {0} deleted.", _
        test9999.Name)
Else
    Console.WriteLine(vbCrLf & "Registry key {0} closed.", _
        test9999.ToString())
    test9999.Close()
End If

Comentários

Você deve ter permissões apropriadas para excluir a subchave e sua árvore.

Cuidado

Excluir uma chave específica removerá todas as entradas abaixo da chave na árvore. Nenhum aviso será fornecido. Se você quiser excluir uma subchave somente quando ela não tiver subchaves filho, use o método DeleteSubKey.

Confira também

• DeleteSubKey(String)
• CreateSubKey(String)
• DeleteValue(String)
• GetSubKeyNames()
• SubKeyCount