深入HRESULT与Windows Error Codes的区别详解
更新时间：2013年05月17日 17:19:25 作者：
本篇文章是对HRESULT与Windows Error Codes的区别进行了详细的分析介绍，需要的朋友参考下
在用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中，可以查到更加详细的资料：
第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中，可以查到更加详细的资料：
第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，碰巧不会出问题，但是建议还是不要这么混用。
总结
相关文章
本文给大家分享了个人对于C++中链表操作的理解，并对具体实例进行了分析，是篇非常不错的学习链表操作的文章，希望大家能够喜欢2017-07-07
大家好，本篇文章主要讲的是C语言中的getchar()使用详解，感兴趣的同学赶快来看一看吧，对你有帮助的话记得收藏一下2022-01-01
static是静止的，静态的意思，那它有什么用呢，今天通过实例代码讲解下C++中static的一些用法，感兴趣的朋友跟随小编一起看看吧2022-12-12
这篇文章主要介绍了C++ explicit关键字的使用详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下2021-09-09
这篇文章主要为大家详细介绍了C++编写实现飞机大战，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-06-06
当我们开发Windows应用程序时，通常会涉及到使用资源（Resource）的情况。资源可以包括图标、位图、字符串等，它们以二进制形式嵌入到可执行文件中，这篇文章主要介绍了C/C++ 实现动态资源文件释放,需要的朋友可以参考下2023-12-12
本文主要介绍了OpenCV实现图像细化算法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2022-08-08
这篇文章主要介绍了C++中deque与vector相比的优势与劣势，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧2023-01-01
本文主要介绍了C++中stack容器的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-03-03
这篇文章主要为大家详细介绍了基于C语言实现三子棋游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2021-08-08
最新评论