RegDeleteKeyExA 函数 (winreg.h)

  • 项目

从注册表的指定平台特定视图中删除子项及其值。 请注意，键名称不区分大小写。

若要将子项作为事务处理操作删除，请调用 RegDeleteKeyTransacted 函数。

语法

LSTATUS RegDeleteKeyExA(
  [in] HKEY   hKey,
  [in] LPCSTR lpSubKey,
  [in] REGSAM samDesired,
       DWORD  Reserved
);

参数

[in] hKey

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

此句柄由 RegCreateKeyEx 或 RegOpenKeyEx 函数返回，也可以是以下 预定义键之一：

HKEY_CLASSES_ROOT
HKEY_CURRENT_CONFIG
HKEY_CURRENT_USER
HKEY_LOCAL_MACHINE
HKEY_USERS

[in] lpSubKey

要删除的文件的名称。 此键必须是 由 hKey 参数的值指定的键的子项。

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

键名称不区分大小写。

此参数的值不能为 NULL。

[in] samDesired

访问掩码 指定注册表的特定于平台的视图。

值 含义
KEY_WOW64_32KEY
0x0200
 从 32 位注册表视图中删除项。
KEY_WOW64_64KEY
0x0100
 从 64 位注册表视图中删除项。

Reserved

此参数是保留的，必须为零。

返回值

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

如果函数失败，则返回值为 Winerror.h 中定义的非零错误代码。 可以将 FormatMessage 函数与 FORMAT_MESSAGE_FROM_SYSTEM 标志结合使用来获取错误的常规说明。

注解

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

在 WOW64 上，32 位应用程序查看与 64 位应用程序视图的注册表树分开的注册表树。 此函数使应用程序能够删除备用注册表视图中的条目。

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

如果函数成功， RegDeleteKeyEx 将从注册表中删除指定的项。 将删除整个键，包括其所有值。

注意

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

注意

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

要求

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

另请参阅

RegCreateKeyEx

RegDeleteKeyTransacted

RegOpenKeyEx

注册表函数

注册表重定向程序