Edit

Marshal.ThrowExceptionForHR Method

  • Reference

Definition

Namespace:
System.Runtime.InteropServices
Assembly:
System.Runtime.InteropServices.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll

Throws an exception with a specific failure HRESULT value.

Overloads

ThrowExceptionForHR(Int32)

Throws an exception with a specific failure HRESULT value.
ThrowExceptionForHR(Int32, IntPtr)

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

ThrowExceptionForHR(Int32)

Source:
Marshal.cs
Source:
Marshal.cs
Source:
Marshal.cs

Throws an exception with a specific failure HRESULT value.

public:
 static void ThrowExceptionForHR(int errorCode);
[System.Security.SecurityCritical]
public static void ThrowExceptionForHR (int errorCode);
public static void ThrowExceptionForHR (int errorCode);
[<System.Security.SecurityCritical>]
static member ThrowExceptionForHR : int -> unit
static member ThrowExceptionForHR : int -> unit
Public Shared Sub ThrowExceptionForHR (errorCode As Integer)

Parameters

errorCode
Int32

The HRESULT corresponding to the desired exception.

Attributes
SecurityCriticalAttribute

Remarks

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):

public static void ThrowExceptionForHR(interrorCode,IntPtrerrorInfo)

See also

Applies to

ThrowExceptionForHR(Int32, IntPtr)

Source:
Marshal.cs
Source:
Marshal.cs
Source:
Marshal.cs

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

public:
 static void ThrowExceptionForHR(int errorCode, IntPtr errorInfo);
[System.Security.SecurityCritical]
public static void ThrowExceptionForHR (int errorCode, IntPtr errorInfo);
public static void ThrowExceptionForHR (int errorCode, IntPtr errorInfo);
[<System.Security.SecurityCritical>]
static member ThrowExceptionForHR : int * nativeint -> unit
static member ThrowExceptionForHR : int * nativeint -> unit
Public Shared Sub ThrowExceptionForHR (errorCode As Integer, errorInfo As IntPtr)

Parameters

errorCode
Int32

The HRESULT corresponding to the desired exception.

errorInfo
IntPtr

nativeint

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.

Attributes
SecurityCriticalAttribute

Remarks

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 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.

See also

Applies to