Função RegDeleteKeyA (winreg.h)

Artigo
08/27/2023

Exclui uma subchave e seus valores. Observe que os nomes de chave não diferenciam maiúsculas de minúsculas.

Windows de 64 bits: Em WOW64, os aplicativos de 32 bits exibem uma árvore do Registro separada da árvore do Registro que os aplicativos de 64 bits exibem. Para permitir que um aplicativo exclua uma entrada na exibição alternativa do Registro, use a função RegDeleteKeyEx .

Sintaxe

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

Parâmetros

[in] hKey

Um identificador para uma chave aberta do Registro. Os direitos de acesso dessa chave não afetam a operação de exclusão. Para obter mais informações sobre direitos de acesso, consulte Segurança de Chave do Registro e Direitos de Acesso.

Esse identificador é retornado pela função RegCreateKeyEx ou RegOpenKeyEx ou pode ser uma das seguintes chaves predefinidas:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in] lpSubKey

O nome da chave a ser excluída. Deve ser uma subchave da chave que hKey identifica, mas não pode ter subchaves. Esse parâmetro não pode ser NULL.

A função abre a subchave com o direito de acesso DELETE.

Os nomes de chave não diferenciam maiúsculas de minúsculas.

Para obter mais informações, consulte Limites de tamanho do elemento do Registro.

Valor retornado

Se a função obtiver êxito, o valor retornado será ERROR_SUCCESS.

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

Comentários

Uma chave excluída não é removida até que o último identificador seja fechado.

A subchave a ser excluída não deve ter subchaves. Para excluir uma chave e todas as suas subchaves, você precisa enumerar as subchaves e excluí-las individualmente. Para excluir chaves recursivamente, use a função RegDeleteTree ou SHDeleteKey .

Exemplos

Para obter um exemplo que usa essa função, consulte Excluindo uma chave com subchaves.

Observação

Em versões herdadas do Windows, essa API também é exposta por kernel32.dll.

Observação

O cabeçalho winreg.h define RegDeleteKey como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos


Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winreg.h (inclua Windows.h)
Biblioteca	Advapi32.lib
DLL	Advapi32.dll