Função RegRenameKey (winreg.h)

  • Artigo

Altera o nome da chave do Registro especificada.

Sintaxe

LSTATUS RegRenameKey(
  HKEY    hKey,
  LPCWSTR lpSubKeyName,
  LPCWSTR lpNewKeyName
);

Parâmetros

hKey

Um identificador para a chave a ser renomeada. O identificador deve ser aberto com o KEY_WRITE direito de acesso. Para obter mais informações, 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

lpSubKeyName

O nome da subchave a ser renomeada. Essa chave deve ser uma subchave da chave identificada pelo parâmetro hKey . Esse parâmetro também pode ser NULL, nesse caso, a chave identificada pelo parâmetro hKey será renomeada.

lpNewKeyName

O novo nome da chave. O novo nome ainda não deve existir.

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. Um código de erro de STATUS_ACCESS_DENIED indica que o chamador não tem os direitos de acesso necessários para a chave ou subchave do Registro especificada.

Comentários

Essa função pode ser usada para renomear uma subárvore inteira do Registro. O chamador deve ter KEY_CREATE_SUB_KEY acesso ao pai da chave especificada e ao acesso DELETE a toda a subárvore que está sendo renomeada.

Requisitos

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

Confira também

RegCopyTree

Funções do Registro

Visão geral do Registro

SECURITY_ATTRIBUTES