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
访问掩码指定特定于平台的注册表视图。
价值 | 意义 |
---|---|
|
从 32 位注册表视图中删除密钥。 |
|
从 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 Edition [仅限桌面应用] |
支持的最低服务器 | 具有 SP1 的 Windows Server 2008、Windows Server 2003 [仅限桌面应用] |
目标平台 | 窗户 |
标头 | winreg.h (包括 Windows.h) |
库 | Advapi32.lib |
DLL | Advapi32.dll |