Função RegDeleteKeyA (winreg.h)
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 aplicativos WOW64, de 32 bits, exibem uma árvore do Registro separada da árvore do Registro que os aplicativos de 64 bits exibem. Para habilitar um aplicativo a excluir uma entrada no modo de exibição alternativo 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 de Segurança de Chave de 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 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. Para obter uma descrição genérica do erro, você pode usar a função FormatMessage com o sinalizador FORMAT_MESSAGE_FROM_SYSTEM.
Observações
Uma chave excluída não será 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
Exemplos
Para obter um exemplo que usa essa função, consulte Excluindo uma chave com subchaves.
Nota
Em versões herdadas do Windows, essa API também é exposta por kernel32.dll.
Nota
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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.
Requisitos
| Requisito | Valor |
|---|---|
| de cliente com suporte mínimo | Windows 2000 Professional [somente aplicativos da área de trabalho] |
| servidor com suporte mínimo | Windows 2000 Server [somente aplicativos da área de trabalho] |
| da Plataforma de Destino |
Windows |
| cabeçalho | winreg.h (inclua Windows.h) |
| biblioteca | Advapi32.lib |
| de DLL |
Advapi32.dll |
Consulte também
RegCreateKeyEx
RegOpenKeyEx