System.Runtime.InteropServices.Marshal.GetExceptionForHR Method

Converts the specified HRESULT error code to a corresponding Exception object, with additional error information passed in an IErrorInfo interface for the exception object.

Syntax

public static Exception GetExceptionForHR (int errorCode, IntPtr errorInfo)

Parameters

errorCode
The HRESULT to be converted.
errorInfo
A pointer to the IErrorInfo interface that provides more information about the error. You can specify IntPtr(0) to use the current IErrorInfo interface, or IntPtr(-1) to ignore the current IErrorInfo interface and construct the exception just from the error code.

Returns

An object that represents the converted HRESULT and information obtained from errorInfo.

Remarks

Use the erload:System.Runtime.InteropServices.Marshal.GetExceptionForHR method to get an Exception based on an HRESULT without having to call the erload:System.Runtime.InteropServices.Marshal.ThrowExceptionForHR method and catch the exception (thus avoiding the corresponding performance overhead). The errorInfo parameter supplies additional information about the error, such as its textual description and the globally unique identifier (GUID) for the interface that defined the error.

Use this method overload if you have custom error information that you have to supply in the conversion.

For the mapping from each HRESULT to its comparable exception class in the .NET Framework, see How to: Map HRESULTs and Exceptions.

Requirements

Namespace: System.Runtime.InteropServices
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0
Since: .NET 2.0