Export (0) Print
Expand All
Expand Minimize

Marshal.GetHRForException Method

Converts the specified exception to an HRESULT.

[Visual Basic]
Public Shared Function GetHRForException( _
   ByVal e As Exception _
) As Integer
[C#]
public static int GetHRForException(
 Exception e
);
[C++]
public: static int GetHRForException(
 Exception* e
);
[JScript]
public static function GetHRForException(
   e : Exception
) : int;

Parameters

e
The Exception to convert to an HRESULT.

Return Value

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 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   This method uses SecurityAction.LinkDemand to prevent it from being called from untrusted code; only the immediate caller is required to have SecurityPermissionAttribute.UnmanagedCode permission. If your code can be called from partially trusted code, do not pass user input to Marshal class methods without validation. For important limitations on using the LinkDemand member, see Demand vs. LinkDemand.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

Marshal Class | Marshal Members | System.Runtime.InteropServices Namespace | PreserveSigAttribute

Show:
© 2015 Microsoft