快捷導(dǎo)航

深入HRESULT與Windows Error Codes的區(qū)別詳解

更新時(shí)間：2013年05月17日 17:19:25 作者：

本篇文章是對(duì)HRESULT與Windows Error Codes的區(qū)別進(jìn)行了詳細(xì)的分析介紹，需要的朋友參考下

在用C++來(lái)開(kāi)發(fā)Windows程序時(shí)，經(jīng)?？吹较旅娴呐袛嗲闆r：

HRESULT hr = ::RegCreateKeyEx(hk, szKeyPath, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_QUERY_VALUE, NULL, &hk, NULL);
if (SUCCEEDED(hr)) 
{

在代碼中，使用SUCCEEDED宏來(lái)判斷函數(shù)RegCreateKeyEx()函數(shù)的返回值。
有些程序員認(rèn)為RegCreateKeyEx返回0的時(shí)候就是成功，而S_OK就是0，所以就習(xí)慣性的用SUCCEEDED宏來(lái)做判斷。
還有些人用下面的方法判斷，看起來(lái)更嚴(yán)謹(jǐn)一些：

復(fù)制代碼代碼如下:

HRESULT hr = ::RegCreateKeyEx(hk, szKeyPath, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_QUERY_VALUE, NULL, &hk, NULL);
if (S_OK == hr) 
{

確實(shí)，第2種更嚴(yán)謹(jǐn)一些，至少不會(huì)造成大問(wèn)題，而第1中則完全是一個(gè)大Bug，這個(gè)bug在正常情況下是沒(méi)有問(wèn)題的。但一旦有問(wèn)題，你也發(fā)現(xiàn)不了。
錯(cuò)在哪里呢？聽(tīng)我下面來(lái)介紹。

SUCCEEDED
先看下這個(gè)宏的定義（WinError.h)：

復(fù)制代碼代碼如下:

//
// Generic test for success on any status value (non-negative numbers
// indicate success).
//
#define SUCCEEDED(hr) ((HRESULT)(hr) >= 0)

從這里可以看出，它就是把hr轉(zhuǎn)換成HRESULT類型，然后做了下是否大于0的判斷。注釋中也說(shuō)明：但值為非負(fù)數(shù)時(shí)表示成功。
也就是說(shuō)，只要HRESULT是大于等于0的值，它就認(rèn)為是成功的。

HRESULT
再來(lái)看下HRESULT的定義(winnt.h)：

復(fù)制代碼代碼如下:

// Component Object Model defines, and macros
#ifndef _HRESULT_DEFINED
#define _HRESULT_DEFINED
typedef LONG HRESULT;
#endif // !_HRESULT_DEFINED

哦，原來(lái)HRESULT就是一個(gè)Long型的整數(shù)。
在MSDN中，可以查到更加詳細(xì)的資料：

如上圖，HRESULT是一個(gè)4字節(jié)的Long型，總共32位。其中：
第31位是s位，即符號(hào)位，因?yàn)镠RESUlT格式規(guī)定所有成功都是正的整數(shù)，失敗的值都是負(fù)數(shù)
第30位是r位，是保留位，但n位（28位）沒(méi)有設(shè)置時(shí)，它必須是0；如果n位使用了，則和s位一起來(lái)標(biāo)識(shí)NTSTATUS的值。
第29位是c位，表示Custom，即自定義位，如果是微軟定義的返回值，則該位為0；如果是自定義的，則該位為1.
第28位是n位，表示NTSTATUS，值為0的話可以把NTSTATUS值映射為一個(gè)HRESULT值。
第27位是x位，保留位，必須為0.
第26位到第16位是Facility，用11位來(lái)表示錯(cuò)誤來(lái)源，比如

復(fù)制代碼代碼如下:

FACILITY_WINDOWS 表示來(lái)自Windows子系統(tǒng)

第15位到第1位是Code位，用來(lái)保存錯(cuò)誤值。

從這里可以看出，只有最后面的2個(gè)字節(jié)是用來(lái)表示返回值的其它的都是輔助信息，它主要用于COM函數(shù)的返回值。

常見(jiàn)HRESULT值

Name	Description	Value
S_OK	操作成功	0x00000000
S_FALSE	操作成功，但是有問(wèn)題	0x00000001L
E_ABORT	操作中止	0x80004004
E_ACCESSDENIED	拒絕訪問(wèn)	0x80070005
E_FAIL	未知錯(cuò)誤	0x80004005

注意：除了S_OK外，還有一個(gè)S_FALSE，它也屬于成功。
所以，微軟為了方便大家使用，專門(mén)提供了SUCCEEDED宏和FAILED宏來(lái)方便大家做判斷。
到這里，大家明白了吧：SUCCEEDED宏是用來(lái)判斷COM中的函數(shù)執(zhí)行是否成功用的，失敗為負(fù)數(shù)，成功為0和正數(shù)。

Windows Error Code
前面的代碼中我們調(diào)用了一個(gè)Windows API：

復(fù)制代碼代碼如下:

:RegCreateKeyEx(hk, szKeyPath, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_QUERY_VALUE, NULL, &hk, NULL);

這個(gè)API的聲明是：

復(fù)制代碼代碼如下:

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中知道，它成功時(shí)返回的是ERROR_SUCCESS，其它值則是失敗，其它值就是類似GetLastError的錯(cuò)誤碼。這些錯(cuò)誤碼就是Windows Error Code。

Windows Error Codes
微軟在WinError.h定義了大量的Windows Error Codes，這種錯(cuò)誤碼范圍是0x0000~0xFFFF，即2個(gè)字節(jié)，但沒(méi)限定死2個(gè)字節(jié)，也可以用4個(gè)字節(jié)來(lái)保存。在Windows API中，大量的使用了這種錯(cuò)誤碼。比如上面的注冊(cè)表API，它的返回值就是這種錯(cuò)誤碼。
這種錯(cuò)誤碼還有個(gè)特點(diǎn)是微軟為這些錯(cuò)誤碼定義了比較詳細(xì)的可閱讀的描述信息，它可以通過(guò)FormatMessage函數(shù)來(lái)獲得，在中文環(huán)境下，顯示的是翻譯后的中文。

Windows Error Codes 除了ERROR_SUCCESS外，都是正數(shù)，也就是不能用SUCCEEDED宏來(lái)判斷，因?yàn)檫@個(gè)宏只判斷是不是非負(fù)數(shù)，對(duì)于它而言，所有的Windows Error Codes都是成功的。

常見(jiàn)的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.