ErrorSupport.FireError Method

Definition

Raises an error.

Overloads

FireError(Int32, Boolean)

Raises an error identified by the specified HRESULT and allows execution to be cancelled.

FireError(Int32, String, String, Int32, Boolean)

Raises an error identified by the specified HRESULT, associates it with the specified component, help file, and help context, and allows execution to be cancelled.

FireError(Int32, Boolean)

Raises an error identified by the specified HRESULT and allows execution to be cancelled.

public:
 void FireError(int hResult, [Runtime::InteropServices::Out] bool % bCancel);
public void FireError (int hResult, out bool bCancel);
member this.FireError : int * bool -> unit
Public Sub FireError (hResult As Integer, ByRef bCancel As Boolean)

Parameters

hResult
Int32

The HRESULT of the underlying COM error.

bCancel
Boolean

true to cancel execution; otherwise, false.

Applies to

FireError(Int32, String, String, Int32, Boolean)

Raises an error identified by the specified HRESULT, associates it with the specified component, help file, and help context, and allows execution to be cancelled.

public:
 void FireError(int hResult, System::String ^ strSubComponent, System::String ^ strHelpFile, int HelpContext, [Runtime::InteropServices::Out] bool % bCancel);
public void FireError (int hResult, string strSubComponent, string strHelpFile, int HelpContext, out bool bCancel);
member this.FireError : int * string * string * int * bool -> unit
Public Sub FireError (hResult As Integer, strSubComponent As String, strHelpFile As String, HelpContext As Integer, ByRef bCancel As Boolean)

Parameters

hResult
Int32

The HRESULT of the underlying COM error.

strSubComponent
String

The friendly name of the component.

strHelpFile
String

The help file that will provide additional information about the messages that are raised.

HelpContext
Int32

The location in the help file that will provide additional information about the messages that are raised.

bCancel
Boolean

true to cancel execution; otherwise, false.

Applies to