This documentation is archived and is not being maintained.

Marshal.GetHRForException Method

Converts the specified exception to an HRESULT.

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

[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public static int GetHRForException(
	Exception e


Type: System.Exception

The Exception to convert to an HRESULT.

Return Value

Type: System.Int32
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 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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0