RegDeleteKeyA 函数 (winreg.h)

删除子项及其值。 请注意,键名称不区分大小写。

64 位 Windows: 在 WOW64 上,32 位应用程序查看与 64 位应用程序视图的注册表树分开的注册表树。 若要使应用程序能够删除备用注册表视图中的条目,请使用 RegDeleteKeyEx 函数。

语法

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

参数

[in] hKey

打开的注册表项的句柄。 此密钥的访问权限不会影响删除操作。 有关访问权限的详细信息,请参阅 注册表项安全性和访问权限

此句柄由 RegCreateKeyExRegOpenKeyEx 函数返回,也可以是以下 预定义键之一:

HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS

[in] lpSubKey

要删除的文件的名称。 它必须是 hKey 标识的项的子项,但它不能具有子项。 此参数不能为 NULL

函数使用 DELETE 访问权限打开子项。

键名称不区分大小写。

有关详细信息,请参阅 注册表元素大小限制

返回值

如果函数成功,则返回值为 ERROR_SUCCESS。

如果函数失败,则返回值为 Winerror.h 中定义的非零错误代码。 若要获取错误的一般说明,可以将 FormatMessage 函数与 FORMAT_MESSAGE_FROM_SYSTEM 标志一起使用。

注解

在关闭已删除密钥的最后一个句柄之前,不会删除该密钥。

要删除的子项不得具有子项。 若要删除某个键及其所有子项,需要枚举子项并单独删除它们。 若要以递归方式删除密钥,请使用 RegDeleteTreeSHDeleteKey 函数。

示例

有关使用此函数的示例,请参阅 使用子项删除密钥

注意

在旧版 Windows 上,此 API 也由 kernel32.dll 公开。

注意

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

要求

   
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 winreg.h (包括 Windows.h)
Library Advapi32.lib
DLL Advapi32.dll

另请参阅

RegCloseKey

RegCreateKeyEx

RegDeleteTree

RegOpenKeyEx

注册表函数

注册表概述

SHDeleteEmptyKey

SHDeleteKey