深入HRESULT与Windows Error Codes的区别详解
更新时间:2020年4月25日 17:47 点击:1650
在用C++来开发Windows程序时,经常看到下面的判断情况:
HRESULT hr = ::RegCreateKeyEx(hk, szKeyPath, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_QUERY_VALUE, NULL, &hk, NULL);
if (SUCCEEDED(hr))
{
在代码中,使用SUCCEEDED宏来判断函数RegCreateKeyEx()函数的返回值。
有些程序员认为RegCreateKeyEx返回0的时候就是成功,而S_OK就是0,所以就习惯性的用SUCCEEDED宏来做判断。
还有些人用下面的方法判断,看起来更严谨一些:
HRESULT hr = ::RegCreateKeyEx(hk, szKeyPath, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_QUERY_VALUE, NULL, &hk, NULL);
if (S_OK == hr)
{
确实,第2种更严谨一些,至少不会造成大问题,而第1中则完全是一个大Bug,这个bug在正常情况下是没有问题的。但一旦有问题,你也发现不了。
错在哪里呢?听我下面来介绍。
SUCCEEDED
先看下这个宏的定义(WinError.h):
//
// Generic test for success on any status value (non-negative numbers
// indicate success).
//
#define SUCCEEDED(hr) ((HRESULT)(hr) >= 0)
从这里可以看出,它就是把hr转换成HRESULT类型,然后做了下是否大于0的判断。注释中也说明:但值为非负数时表示成功。
也就是说,只要HRESULT是大于等于0的值,它就认为是成功的。
HRESULT
再来看下HRESULT的定义(winnt.h):
// Component Object Model defines, and macros
#ifndef _HRESULT_DEFINED
#define _HRESULT_DEFINED
typedef LONG HRESULT;
#endif // !_HRESULT_DEFINED
哦,原来HRESULT就是一个Long型的整数。
在MSDN中,可以查到更加详细的资料:
如上图,HRESULT是一个4字节的Long型,总共32位。其中:
第31位是s位,即符号位,因为HRESUlT格式规定所有成功都是正的整数,失败的值都是负数
第30位是r位,是保留位,但n位(28位)没有设置时,它必须是0;如果n位使用了,则和s位一起来标识NTSTATUS的值。
第29位是c位,表示Custom,即自定义位,如果是微软定义的返回值,则该位为0;如果是自定义的,则该位为1.
第28位是n位,表示NTSTATUS,值为0的话可以把NTSTATUS值映射为一个HRESULT值。
第27位是x位,保留位,必须为0.
第26位到第16位是Facility,用11位来表示错误来源,比如
FACILITY_WINDOWS 表示来自Windows子系统
第15位到第1位是Code位,用来保存错误值。
从这里可以看出,只有最后面的2个字节是用来表示返回值的其它的都是辅助信息,它主要用于COM函数的返回值。
常见HRESULT值
注意:除了S_OK外,还有一个S_FALSE,它也属于成功。
所以,微软为了方便大家使用,专门提供了SUCCEEDED宏和FAILED宏来方便大家做判断。
到这里,大家明白了吧:SUCCEEDED宏是用来判断COM中的函数执行是否成功用的,失败为负数,成功为0和正数。
Windows Error Code
前面的代码中我们调用了一个Windows API:
:RegCreateKeyEx(hk, szKeyPath, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_QUERY_VALUE, NULL, &hk, NULL);
这个API的声明是:
LONG WINAPI RegCreateKeyEx(
__in HKEY hKey,
__in LPCTSTR lpSubKey,
__reserved DWORD Reserved,
__in_opt LPTSTR lpClass,
__in DWORD dwOptions,
__in REGSAM samDesired,
__in_opt LPSECURITY_ATTRIBUTES lpSecurityAttributes,
__out PHKEY phkResult,
__out_opt LPDWORD lpdwDisposition
);
从MSDN中知道,它成功时返回的是ERROR_SUCCESS,其它值则是失败,其它值就是类似GetLastError的错误码。这些错误码就是Windows Error Code。
Windows Error Codes
微软在WinError.h定义了大量的Windows Error Codes,这种错误码范围是0x0000~0xFFFF,即2个字节,但没限定死2个字节,也可以用4个字节来保存。在Windows API中,大量的使用了这种错误码。比如上面的注册表API,它的返回值就是这种错误码。
这种错误码还有个特点是微软为这些错误码定义了比较详细的可阅读的描述信息,它可以通过FormatMessage函数来获得,在中文环境下,显示的是翻译后的中文。
Windows Error Codes 除了ERROR_SUCCESS外,都是正数,也就是不能用SUCCEEDED宏来判断,因为这个宏只判断是不是非负数,对于它而言,所有的Windows Error Codes都是成功的。
常见的Windows Error Codes
复制代码 代码如下:
HRESULT hr = ::RegCreateKeyEx(hk, szKeyPath, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_QUERY_VALUE, NULL, &hk, NULL);
if (SUCCEEDED(hr))
{
在代码中,使用SUCCEEDED宏来判断函数RegCreateKeyEx()函数的返回值。
有些程序员认为RegCreateKeyEx返回0的时候就是成功,而S_OK就是0,所以就习惯性的用SUCCEEDED宏来做判断。
还有些人用下面的方法判断,看起来更严谨一些:
复制代码 代码如下:
HRESULT hr = ::RegCreateKeyEx(hk, szKeyPath, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_QUERY_VALUE, NULL, &hk, NULL);
if (S_OK == hr)
{
确实,第2种更严谨一些,至少不会造成大问题,而第1中则完全是一个大Bug,这个bug在正常情况下是没有问题的。但一旦有问题,你也发现不了。
错在哪里呢?听我下面来介绍。
SUCCEEDED
先看下这个宏的定义(WinError.h):
复制代码 代码如下:
//
// Generic test for success on any status value (non-negative numbers
// indicate success).
//
#define SUCCEEDED(hr) ((HRESULT)(hr) >= 0)
从这里可以看出,它就是把hr转换成HRESULT类型,然后做了下是否大于0的判断。注释中也说明:但值为非负数时表示成功。
也就是说,只要HRESULT是大于等于0的值,它就认为是成功的。
HRESULT
再来看下HRESULT的定义(winnt.h):
复制代码 代码如下:
// Component Object Model defines, and macros
#ifndef _HRESULT_DEFINED
#define _HRESULT_DEFINED
typedef LONG HRESULT;
#endif // !_HRESULT_DEFINED
哦,原来HRESULT就是一个Long型的整数。
在MSDN中,可以查到更加详细的资料:
如上图,HRESULT是一个4字节的Long型,总共32位。其中:
第31位是s位,即符号位,因为HRESUlT格式规定所有成功都是正的整数,失败的值都是负数
第30位是r位,是保留位,但n位(28位)没有设置时,它必须是0;如果n位使用了,则和s位一起来标识NTSTATUS的值。
第29位是c位,表示Custom,即自定义位,如果是微软定义的返回值,则该位为0;如果是自定义的,则该位为1.
第28位是n位,表示NTSTATUS,值为0的话可以把NTSTATUS值映射为一个HRESULT值。
第27位是x位,保留位,必须为0.
第26位到第16位是Facility,用11位来表示错误来源,比如
复制代码 代码如下:
FACILITY_WINDOWS 表示来自Windows子系统
第15位到第1位是Code位,用来保存错误值。
从这里可以看出,只有最后面的2个字节是用来表示返回值的其它的都是辅助信息,它主要用于COM函数的返回值。
常见HRESULT值
Name | Description | Value |
S_OK | 操作成功 | 0x00000000 |
S_FALSE | 操作成功,但是有问题 | 0x00000001L |
E_ABORT | 操作中止 | 0x80004004 |
E_ACCESSDENIED | 拒绝访问 | 0x80070005 |
E_FAIL | 未知错误 | 0x80004005 |
注意:除了S_OK外,还有一个S_FALSE,它也属于成功。
所以,微软为了方便大家使用,专门提供了SUCCEEDED宏和FAILED宏来方便大家做判断。
到这里,大家明白了吧:SUCCEEDED宏是用来判断COM中的函数执行是否成功用的,失败为负数,成功为0和正数。
Windows Error Code
前面的代码中我们调用了一个Windows API:
复制代码 代码如下:
:RegCreateKeyEx(hk, szKeyPath, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_QUERY_VALUE, NULL, &hk, NULL);
这个API的声明是:
复制代码 代码如下:
LONG WINAPI RegCreateKeyEx(
__in HKEY hKey,
__in LPCTSTR lpSubKey,
__reserved DWORD Reserved,
__in_opt LPTSTR lpClass,
__in DWORD dwOptions,
__in REGSAM samDesired,
__in_opt LPSECURITY_ATTRIBUTES lpSecurityAttributes,
__out PHKEY phkResult,
__out_opt LPDWORD lpdwDisposition
);
从MSDN中知道,它成功时返回的是ERROR_SUCCESS,其它值则是失败,其它值就是类似GetLastError的错误码。这些错误码就是Windows Error Code。
Windows Error Codes
微软在WinError.h定义了大量的Windows Error Codes,这种错误码范围是0x0000~0xFFFF,即2个字节,但没限定死2个字节,也可以用4个字节来保存。在Windows API中,大量的使用了这种错误码。比如上面的注册表API,它的返回值就是这种错误码。
这种错误码还有个特点是微软为这些错误码定义了比较详细的可阅读的描述信息,它可以通过FormatMessage函数来获得,在中文环境下,显示的是翻译后的中文。
Windows Error Codes 除了ERROR_SUCCESS外,都是正数,也就是不能用SUCCEEDED宏来判断,因为这个宏只判断是不是非负数,对于它而言,所有的Windows Error Codes都是成功的。
常见的Windows Error Codes
Win32 error codes | Description |
0x00000000 ERROR_SUCCESS |
The operation completed successfully. |
0x00000000 NERR_Success |
The operation completed successfully. |
0x00000001 ERROR_INVALID_FUNCTION |
Incorrect function. |
0x00000002 ERROR_FILE_NOT_FOUND |
The system cannot find the file specified. |
0x00000003 ERROR_PATH_NOT_FOUND |
The system cannot find the path specified. |
0x00000004 ERROR_TOO_MANY_OPEN_FILES |
The system cannot open the file. |
0x00000005 ERROR_ACCESS_DENIED |
Access is denied. |
所以前面的代码中,混淆了HRESULT和Windows Error Code,特别是第一种代码,当注册表失败时它也会判断为成功,第2种因为两个都是0,碰巧不会出问题,但是建议还是不要这么混用。
总结
相关文章
- VPN可以虚拟出一个专用网络,让远处的计算机和你相当于处在同一个局域网中,而中间的数据也可以实现加密传输,用处很大,特别是在一些大公司,分公司处在不同的区域。...2016-01-27
- 在程序员中,尤其是go新手,经常听到的一个讨论话题是:如何处理错误,这篇文章主要给大家介绍了关于Go应用中优雅处理Error的一些相关技巧,需要的朋友可以参考下...2021-09-08
- 这篇文章主要介绍了Windows批量搜索并复制/剪切文件的批处理程序实例,需要的朋友可以参考下...2020-06-30
- 这篇文章主要为大家详细介绍了C#创建一个简单windows窗体应用的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2020-06-25
- 这篇文章主要介绍了Powershell 查询 Windows 日志的方法,需要的朋友可以参考下...2020-06-30
- 这篇文章主要介绍了C#实现windows form限制文本框输入的方法,涉及C#限制文本框输入的技巧,非常具有实用价值,需要的朋友可以参考下...2020-06-25
解决Docker中的error during connect异常情况
这篇文章主要介绍了解决Docker中的error during connect异常情况,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-11-22- 本文实例讲述了JS实现不使用图片仿Windows右键菜单效果代码。分享给大家供大家参考,具体如下:这里演示JS不使用图片仿Windows右键菜单效果,这款代码灵活使用了文鼎字,配合CSS和JS做出了这个和系统右键菜单很相似的东东。...2015-10-23
C# Windows API应用之基于GetDesktopWindow获得桌面所有窗口句柄的方法
这篇文章主要介绍了C# Windows API应用之基于GetDesktopWindow获得桌面所有窗口句柄的方法,结合实例形式分析了GetDesktopWindow函数用于获取窗口句柄的具体使用方法与相关注意事项,需要的朋友可以参考下...2020-06-25- 作为一个新生事物,Linux吸引了不少眼球,但是它能否快捷、方便地与Windows资源共享,是一个很重要的问题。大家知道,Windows之间可以利用“网络邻居”来实现资源共享,而Linux...2016-11-25
- 这篇文章主要介绍了利用C#修改Windows操作系统时间,帮助大家更好的利用c#操作系统,感兴趣的朋友可以了解下...2020-12-08
- 本篇文章主要介绍了详解Windows下安装Nodejs步骤,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧 ...2017-05-22
error LNK2019: 无法解析的外部符号 问题的解决办法
error LNK2019: 无法解析的外部符号 问题的解决办法,需要的朋友可以参考一下...2020-04-25关于MySQL绕过授予information_schema中对象时报ERROR 1044(4200)错误
这篇文章主要介绍了关于MySQL绕过授予information_schema中对象时报ERROR 1044(4200)错误,本文给大家分享解决方法,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2020-10-17C#3.0使用EventLog类写Windows事件日志的方法
这篇文章主要介绍了C#3.0使用EventLog类写Windows事件日志的方法,以简单实例形式分析了C#写windows事件日志的技巧,具有一定参考借鉴价值,需要的朋友可以参考下...2020-06-25Windows Server 2012 R2或2016无法安装.NET Framework 3.5.1的解决方法
这篇文章主要为大家详细介绍了Windows Server 2012 R2或2016无法安装.NET Framework 3.5.1,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2017-07-06- 目前在做window.onerror时上报js错误信息的事,整理下相关资料,需要的朋友可以参考下...2016-01-29
Windows Server 2016 上配置 APACHE+SSL+PHP+perl的教程详解
Windows Server 2016 上配置 APACHE+SSL+PHP+perl怎么配置?小编推荐了一篇介绍Windows Server 2016 上配置 APACHE+SSL+PHP+perl的教程,有需要的同学快来看看吧! ...2017-07-06- 这篇文章主要介绍了C#实现控制Windows系统关机、重启和注销的方法,涉及C#调用windows系统命令实现控制开机、关机等操作的技巧,非常简单实用,需要的朋友可以参考下...2020-06-25
MySQL ERROR 1045 (28000) 错误的解决办法
这篇文章主要介绍了MySQL ERROR 1045 (28000) 错误的解决办法,很实用的解决方法,感兴趣的小伙伴们可以参考一下...2016-06-24