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

Статья
03/04/2024

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

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

Синтаксис

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

Параметры

[in] hKey

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

HKEY_USERS HKEY_LOCAL_MACHINE

[in, optional] lpSubKey

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

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

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

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

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

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

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

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

Примечание

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

Требования

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