Export (0) Print
Expand All

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)

[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public static Exception GetExceptionForHR(
	int errorCode,
	IntPtr errorInfo
)

Parameters

errorCode
Type: System.Int32

The HRESULT to be converted.

errorInfo
Type: System.IntPtr

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

Type: System.Exception
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 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft