RegDeleteTreeA 函数 (winreg.h)

以递归方式删除指定键的子项和值。

语法

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

[in] hKey

打开的注册表项的句柄。必须已使用以下访问权限打开密钥：DELETE、KEY_ENUMERATE_SUB_KEYS 和 KEY_QUERY_VALUE。有关详细信息，请参阅注册表项安全和访问权限。

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 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。有关详细信息，请参阅函数原型的约定。