Função RegLoadKeyA (winreg.h)

Artigo
03/13/2024

Cria uma subchave em HKEY_USERS ou HKEY_LOCAL_MACHINE e carrega os dados do hive do registro especificado nessa subchave.

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 RegLoadKeyA(
  [in]           HKEY   hKey,
  [in, optional] LPCSTR lpSubKey,
  [in]           LPCSTR lpFile
);

Parâmetros

[in] hKey

Um identificador para a chave em que a subchave será criada. Esse pode ser um identificador retornado por uma chamada para RegConnectRegistry ou um dos seguintes identificadores predefinidos:

HKEY_LOCAL_MACHINEHKEY_USERS Essa função sempre carrega informações na parte superior da hierarquia do Registro. Os valores de identificador de HKEY_CLASSES_ROOT e HKEY_CURRENT_USER não podem ser especificados para esse parâmetro, pois representam subconjuntos dos valores de identificador HKEY_LOCAL_MACHINE e HKEY_USERS , respectivamente.

[in, optional] lpSubKey

O nome da chave a ser criada em hKey. Essa subchave é onde as informações de registro do arquivo serão carregadas.

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.

[in] lpFile

O nome do arquivo que contém os dados do Registro. Esse arquivo deve ser um arquivo local que foi criado com a função RegSaveKey . Se esse arquivo não existir, um arquivo será criado com o nome especificado.

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

Há dois formatos de arquivo hive do registro. Os hives do Registro criados nos sistemas operacionais atuais normalmente não podem ser carregados por outros anteriores.

Se hKey for um identificador retornado por RegConnectRegistry, o caminho especificado em lpFile será relativo ao computador remoto.

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. Para carregar um hive sem exigir esses privilégios especiais, use a função RegLoadAppKey .

Observação

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