Função RegUnLoadKeyA (winreg.h)

Artigo
03/13/2024

Descarrega a chave do Registro especificada e suas subchaves do registro.

Os aplicativos que fazem backup ou restauram o estado do sistema, incluindo arquivos do sistema e hives do Registro, devem usar o Serviço de Cópia de Sombra de Volume em vez das funções do Registro.

Sintaxe

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

Parâmetros

[in] hKey

Um identificador para a chave do Registro a ser descarregada. Esse parâmetro pode ser um identificador retornado por uma chamada para a função RegConnectRegistry ou um dos seguintes identificadores predefinidos:

HKEY_USERS HKEY_LOCAL_MACHINE

[in, optional] lpSubKey

O nome da subchave a ser descarregada. A chave referenciada pelo parâmetro lpSubKey deve ter sido criada usando a função RegLoadKey .

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.

Retornar valor

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. Você pode usar a função FormatMessage com o sinalizador FORMAT_MESSAGE_FROM_SYSTEM para obter uma descrição genérica do erro.

Comentários

Essa função remove um hive do registro, mas não modifica o arquivo que contém as informações do Registro. Um hive é um corpo discreto de chaves, subchaves e valores que tem raiz na parte superior da hierarquia do Registro.

O processo de chamada deve ter os privilégios SE_RESTORE_NAME e SE_BACKUP_NAME no computador em que o registro reside. Para obter mais informações, confira Executar com privilégios especiais.

Observação

O cabeçalho winreg.h define RegUnLoadKey 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

Requisito	Valor
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