Função RegDeleteTreeA (winreg.h)

Exclui as subchaves e os valores da chave especificada recursivamente.

Sintaxe

LSTATUS RegDeleteTreeA(
  [in]           HKEY   hKey,
  [in, optional] LPCSTR lpSubKey
);

Parâmetros

[in] hKey

Um identificador para uma chave aberta do Registro. A chave deve ter sido aberta com os seguintes direitos de acesso: DELETE, KEY_ENUMERATE_SUB_KEYS e KEY_QUERY_VALUE. Para obter mais informações, consulte de Direitos de Acesso e Segurança de Chave do Registro.

Esse identificador é retornado peloRegCreateKeyEx , RegCreateKeyTransacted, RegOpenKeyExou função regOpenKeyTransacted ou pode ser uma das seguintes chaves predefinidas:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in, optional] lpSubKey

O nome da chave. Essa chave deve ser uma subchave da chave identificada pelo parâmetro hKey . Se esse parâmetro for NULL, as subchaves e os valores de hKey serão excluídos.

Valor de retorno

Se a função for bem-sucedida, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor retornado será um código de erro diferente de zero definido em Winerror.h. Você pode usar a função FormatMessage com o sinalizador FORMAT_MESSAGE_FROM_SYSTEM para obter uma descrição genérica do erro.

Observações

Se a chave tiver valores, ela deverá ser aberta com KEY_SET_VALUE ou essa função falhará com ERROR_ACCESS_DENIED.

Para compilar um aplicativo que usa essa função, defina _WIN32_WINNT como 0x0600 ou posterior. Para obter mais informações, consulte Usando os cabeçalhos do Windows.

Requisitos

Consulte também

RegDeleteKey

RegDeleteKeyEx

RegDeleteKeyTransacted

Funções do Registro