Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Expand Minimize

Marshal.GetHRForException Method

Converts the specified exception to an HRESULT.

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

public static int GetHRForException (
	Exception e
)
public static int GetHRForException (
	Exception e
)
public static function GetHRForException (
	e : Exception
) : int
Not applicable.

Parameters

e

The Exception to convert to an HRESULT.

Return Value

The HRESULT mapped to the supplied exception.

GetHRForException also sets up an IErrorInfo interface for the exception that can be obtained by calling the GetErrorInfo COM API method. You can use this method to return an HRESULT value on a managed class implemention of a COM interface where you apply the System.Runtime.InteropServices.PreserveSigAttribute. Have the attributed method catch all exceptions and use GetHRForException to return the appropriate HRESULT value. Allowing an exception to propagate outside the method produces incorrect behavior. (In fact, the common language runtime fails to pass an exception to a COM client calling such a method through a v-table.) For additional information about the IErrorInfo interface and GetErrorInfo COM methods, see the MSDN Library.

Note that the GetHRForException method sets the IErrorInfo of the current thread. This can cause unexpected results for methods like the ThrowExceptionForHR methods that default to using the IErrorInfo of the current thread if it is set.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2015 Microsoft