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

Статья
11/20/2024

Удаляет вложенные ключи и значения указанного ключа рекурсивно.

Синтаксис

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

Параметры

[in] hKey

Дескриптор открытого раздела реестра. Ключ должен быть открыт со следующими правами доступа: DELETE, KEY_ENUMERATE_SUB_KEYS и KEY_QUERY_VALUE. Дополнительные сведения см. в разделе "Безопасность и права доступа реестра".

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

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in, optional] lpSubKey

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

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

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

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

Замечания

Если ключ имеет значения, он должен быть открыт с помощью KEY_SET_VALUE или эта функция завершится ошибкой с ERROR_ACCESS_DENIED.

Чтобы скомпилировать приложение, использующее эту функцию, определите _WIN32_WINNT как 0x0600 или более поздней версии. Дополнительные сведения см. в разделе Использование заголовков Windows.

Заметка

В устаревших версиях Windows этот API также предоставляется kernel32.dll.

Заметка

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

Требования

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

См. также

RegDeleteKey

RegDeleteKeyEx

RegDeleteKeyTransacted

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

Поделиться через