ErrorSupport.FireErrorWithArgs Method

Definition

Namespace:

Microsoft.SqlServer.Dts.ManagedMsg

Assembly:

Microsoft.SqlServer.DtsMsg.dll

Raises an error with the option to provide an array of user-defined objects or information.

Overloads

FireErrorWithArgs(Int32, Boolean, Object[])	Raises an error identified by the specified HRESULT, allows execution to be cancelled, and includes an optional array of user-defined objects or information.
FireErrorWithArgs(Int32, String, String, Int32, Boolean, Object[])	Raises an error identified by the specified HRESULT, associates it with the specified component, help file, and help context, allows execution to be cancelled, and includes an optional array of user-defined objects or information.

FireErrorWithArgs(Int32, Boolean, Object[])

Raises an error identified by the specified HRESULT, allows execution to be cancelled, and includes an optional array of user-defined objects or information.

public:
 void FireErrorWithArgs(int hResult, [Runtime::InteropServices::Out] bool % bCancel, ... cli::array <System::Object ^> ^ paramList);

public void FireErrorWithArgs (int hResult, out bool bCancel, params object[] paramList);

member this.FireErrorWithArgs : int * bool * obj[] -> unit

Public Sub FireErrorWithArgs (hResult As Integer, ByRef bCancel As Boolean, ParamArray paramList As Object())

Parameters

hResult

Int32

The HRESULT of the underlying COM error.

bCancel

Boolean

true to cancel execution; otherwise, false.

paramList

Object[]

An optional array of user-defined objects or information.

FireErrorWithArgs(Int32, String, String, Int32, Boolean, Object[])

Raises an error identified by the specified HRESULT, associates it with the specified component, help file, and help context, allows execution to be cancelled, and includes an optional array of user-defined objects or information.

public:
 void FireErrorWithArgs(int hResult, System::String ^ strSubComponent, System::String ^ strHelpFile, int HelpContext, [Runtime::InteropServices::Out] bool % bCancel, ... cli::array <System::Object ^> ^ paramList);

public void FireErrorWithArgs (int hResult, string strSubComponent, string strHelpFile, int HelpContext, out bool bCancel, params object[] paramList);

member this.FireErrorWithArgs : int * string * string * int * bool * obj[] -> unit

Public Sub FireErrorWithArgs (hResult As Integer, strSubComponent As String, strHelpFile As String, HelpContext As Integer, ByRef bCancel As Boolean, ParamArray paramList As Object())

Parameters

hResult

Int32

The HRESULT of the underlying COM error.

strSubComponent

String

The friendly name of the component.

strHelpFile

String

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

HelpContext

Int32

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

bCancel

Boolean

true to cancel execution; otherwise, false.

paramList

Object[]

An optional array of user-defined objects or information.