ThrowExceptionForHR Method (Int32)
Collapse the table of content
Expand the table of content

Marshal.ThrowExceptionForHR Method (Int32)

 

Throws an exception with a specific failure HRESULT value.

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

[SecurityCriticalAttribute]
public static void ThrowExceptionForHR(
	int errorCode
)

Parameters

errorCode
Type: System.Int32

The HRESULT corresponding to the desired exception.

This method creates an exception object for the specified failure HRESULT. If the HRESULT is 0 or positive (a success code), the method returns without creating or throwing an exception.

Note that the ThrowExceptionForHR(Int32) method returns an exception based on the IErrorInfo interface of the current thread if one is set. When this happens, the errorCode parameter is ignored.

Some failure HRESULTs map to defined exceptions, whereas others do not. If the HRESULT maps to a defined exception, ThrowExceptionForHR creates an instance of the exception and throws it. Otherwise, it creates an instance of COMException, initializes the error code field with the HRESULT, and throws that exception. When ThrowExceptionForHR is invoked, it attempts to retrieve extra information regarding the error by using the unmanaged GetErrorInfo function.

For the mapping from each HRESULT to its comparable exception class in the .NET Framework, see How to: Map HRESULTs and Exceptions.

Occasionally, ThrowExceptionForHR might return an exception from a previous COM call. In this case, you can use the following workaround and pass IntPtr(-1) as the second parameter (errorInfo):

[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public static void ThrowExceptionForHR(interrorCode,IntPtrerrorInfo)

SecurityCriticalAttribute

requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft