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

Статья
11/20/2024

Выгрузит указанный раздел реестра и его подразделы из реестра.

Приложения, которые выполняют резервное копирование или восстановление состояния системы, включая системные файлы и кусты реестра, должны использовать службу теневого копирования томов вместо функций реестра.

Синтаксис

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

Параметры

[in] hKey

Дескриптор раздела реестра, который необходимо выгрузить. Этот параметр может быть дескриптором, возвращаемым вызовом функции RegConnectRegistry или одной из следующих предопределенных дескрипторов:

HKEY_LOCAL_MACHINEHKEY_USERS

[in, optional] lpSubKey

Имя выгрузочного подраздела. Ключ, на который ссылается параметр lpSubKey, должен быть создан с помощью функции RegLoadKey.

Имена ключей не учитывает регистр.

Дополнительные сведения см. в разделе Ограничения размера элемента реестра.

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

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

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

Замечания

Эта функция удаляет куст из реестра, но не изменяет файл, содержащий сведения о реестре. Hive — это дискретный текст ключей, вложенных ключей и значений, корневых в верхней части иерархии реестра.

Вызов должен иметь права SE_RESTORE_NAME и SE_BACKUP_NAME на компьютере, в котором находится реестр. Дополнительные сведения см. в разделе Выполнение с специальными привилегиями.

Заметка

Заголовок winreg.h определяет RegUnLoadKey как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winreg.h (включая Windows.h)
библиотеки	Advapi32.lib
DLL	Advapi32.dll