Функция SHDeleteKeyW (shlwapi.h)

Статья
11/20/2024

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

Синтаксис

LSTATUS SHDeleteKeyW(
  [in]           HKEY    hkey,
  [in, optional] LPCWSTR pszSubKey
);

Параметры

[in] hkey

Тип: HKEY

Дескриптор открытого раздела реестра или один из следующих предопределенных ключей:

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Тип: LPCTSTR

Адрес строки, завершаемой значением NULL, указывающий имя ключа для удаления.

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

Тип: LSTATUS

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

Замечания

Кроме того, используйте функцию RegDeleteKey или RegDeleteTree.

Заметка

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

Требования

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

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