Função SHDeleteKeyA (shlwapi.h)

Artigo
11/20/2024

Exclui uma subchave e todos os seus descendentes. Essa função remove a chave e todos os valores da chave do Registro.

Sintaxe

LSTATUS SHDeleteKeyA(
  [in]           HKEY   hkey,
  [in, optional] LPCSTR pszSubKey
);

Parâmetros

[in] hkey

Tipo: HKEY

Um identificador para uma chave do Registro aberta ou uma das seguintes chaves predefinidas :

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Tipo: LPCTSTR

O endereço de uma cadeia de caracteres terminada em nulo especificando o nome da chave a ser excluída.

Valor de retorno

Tipo: LSTATUS

Retorna ERROR_SUCCESS se tiver êxito ou um código de erro diferente de zero definido em Winerror.h caso contrário. Você pode usar a função FormatMessage com o sinalizador FORMAT_MESSAGE_FROM_SYSTEM para recuperar uma descrição genérica do erro.

Observações

Como alternativa, use a função RegDeleteKey ou RegDeleteTree.

Nota

O cabeçalho shlwapi.h define SHDeleteKey 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. 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, Windows XP [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	shlwapi.h
biblioteca	Shlwapi.lib
de DLL	Shlwapi.dll (versão 4.71 ou posterior)

Compartilhar via