Export (0) Print
Expand All

Marshal.ThrowExceptionForHR Method (Int32, IntPtr)

Throws an exception with a specific failure HRESULT, based on the specified IErrorInfo Interface interface.

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

public static void ThrowExceptionForHR(
	int errorCode,
	IntPtr errorInfo
)

Parameters

errorCode
Type: System.Int32

The HRESULT corresponding to the desired exception.

errorInfo
Type: System.IntPtr

A pointer to the IErrorInfo interface that provides more information about the error. You can specify IntPtr(0) to use the current IErrorInfo interface, or IntPtr(-1) to ignore the current IErrorInfo interface and construct the exception just from the error code.

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.

The ThrowExceptionForHR method releases the errorInfo parameter, decreasing the COM reference count of the IErrorInfo interface.

Note that the ThrowExceptionForHR method returns an exception based on the IErrorInfo Interface 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 System.Runtime.InteropServices.COMException, initializes the error code field with the HRESULT, and throws that exception. The errorInfo parameter is used to retrieve extra information regarding the error.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

  • SecurityCriticalAttribute 

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

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft