HRESULT

HRESULT

The HRESULT data type is a 32-bit value that is used to describe an error or warning.

typedef LONG          HRESULT; 
 

Remarks

On 32-bit platforms, the HRESULT data type is the same as the SCODE data type. On 16-bit platforms, an SCODE value is used to generate an HRESULT value.

An HRESULT value is made up of the following fields:

• A 1-bit code indicating severity, where zero represents success and 1 represents failure.
• A 4-bit reserved value.
• An 11-bit code indicating responsibility for the error or warning, also known as a facility code.
• A 16-bit code describing the error or warning.

Most MAPI interface methods and functions return HRESULT values to provide detailed result information. HRESULT values are also used widely in OLE interface methods. OLE provides several macros for converting between HRESULT values and SCODE values, another common data type for error handling. For information about the OLE use of HRESULT values, see the OLE Programmer's Reference. For more information about the use of these values in MAPI, see Error Handling and any of the following interface methods: