This documentation is archived and is not being maintained.

Marshal.GetExceptionForHR Method (Int32, IntPtr)

Note: This method is new in the .NET Framework version 2.0.

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

Parameters

errorCode

The HRESULT to be converted.

errorInfo

A pointer to the IErrorInfo interface providing more information about the error.

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.

For additional information about the IErrorInfo interface, see the MSDN Library.

Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: