Marshal.GetHRForException(Exception) Method

Definition

Namespace:

System.Runtime.InteropServices

Assembly:

System.Runtime.InteropServices.dll

Source:

Marshal.NoCom.cs

Converts the specified exception to an HRESULT.

public:
 static int GetHRForException(Exception ^ e);

public static int GetHRForException (Exception? e);

static member GetHRForException : Exception -> int

Public Shared Function GetHRForException (e As Exception) As Integer

Parameters

e

Exception

The exception to convert to an HRESULT.

Returns

Int32

The HRESULT mapped to the supplied exception.

Remarks

GetHRForException also sets up an IErrorInfo interface for the exception that can be obtained by calling the COM GetErrorInfoNEEDGUID function. You can use this function to return an HRESULT value on a managed class implementation of a COM interface where you apply the PreserveSigAttribute attribute. Have the attributed method catch all exceptions and use the GetHRForException method 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 that calls such a method through a v-table.)

Note that the GetHRForException method sets the IErrorInfo interface 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.

See also

• PreserveSigAttribute