This documentation is archived and is not being maintained.

Marshal.GetExceptionForHR Method (Int32, IntPtr)

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

Namespace: System.Runtime.InteropServices
Assembly: mscorlib (in mscorlib.dll)

public static Exception GetExceptionForHR (
	int errorCode,
	IntPtr errorInfo
)
public static Exception GetExceptionForHR (
	int errorCode, 
	IntPtr errorInfo
)
public static function GetExceptionForHR (
	errorCode : int, 
	errorInfo : IntPtr
) : Exception
Not applicable.

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.

Return Value

An Exception object representing the converted HRESULT and information obtained from errorInfo.

Use the GetExceptionForHR method to get an Exception based on an HRESULT without having to call the ThrowExceptionForHR method and catch the exception (thus avoiding the corresponding performance overhead). The errorInfo parameter is used to supply extra information about the error, such as a textual description of the error 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 need 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.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: