Функция RegRenameKey (winreg.h)

  • Статья

Изменяет имя указанного раздела реестра.

Синтаксис

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

Параметры

hKey

Дескриптор переименовываемого ключа. Дескриптор должен быть открыт с правом доступа KEY_WRITE. Дополнительные сведения см. в разделе Безопасность раздела реестра и права доступа.

Этот дескриптор возвращается функцией RegCreateKeyEx или RegOpenKeyEx или может быть одним из следующих предопределенных ключей:

  • HKEY_CLASSES_ROOT
  • HKEY_CURRENT_CONFIG
  • HKEY_CURRENT_USER
  • HKEY_LOCAL_MACHINE
  • HKEY_USERS

lpSubKeyName

Имя подраздела, который требуется переименовать. Этот ключ должен быть подразделом ключа, определяемого параметром hKey . Этот параметр также может иметь значение NULL, и в этом случае ключ, определенный параметром hKey , будет переименован.

lpNewKeyName

Новое имя ключа. Новое имя не должно существовать.

Возвращаемое значение

Если функция выполняется успешно, возвращаемое значение будет ERROR_SUCCESS.

Если функция завершается сбоем, возвращаемое значение представляет собой ненулевой код ошибки, определенный в Winerror.h. Чтобы получить общее описание ошибки, можно использовать функцию FormatMessage с флагом FORMAT_MESSAGE_FROM_SYSTEM. Код ошибки STATUS_ACCESS_DENIED указывает, что вызывающий объект не имеет необходимых прав доступа к указанному разделу реестра или подразделам.

Комментарии

Эту функцию можно использовать для переименования всего поддеревья реестра. Вызывающий объект должен иметь KEY_CREATE_SUB_KEY доступ к родительскому элементу указанного ключа и доступ DELETE ко всему переименованию поддеревого.

Требования

Требование Значение
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2008 [только классические приложения]
Верхняя часть winreg.h (включая Windows.h)
Библиотека Advapi32.lib
DLL Advapi32.dll

См. также раздел

RegCopyTree

Функции реестра

Общие сведения о реестре

SECURITY_ATTRIBUTES