Share via


DefaultEvents.OnCustomEvent Method

Definition

This method is called by tasks to raise custom task-defined events.

public:
 virtual void OnCustomEvent(Microsoft::SqlServer::Dts::Runtime::TaskHost ^ taskHost, System::String ^ eventName, System::String ^ eventText, cli::array <System::Object ^> ^ % arguments, System::String ^ subComponent, bool % fireAgain);
public virtual void OnCustomEvent (Microsoft.SqlServer.Dts.Runtime.TaskHost taskHost, string eventName, string eventText, ref object[] arguments, string subComponent, ref bool fireAgain);
abstract member OnCustomEvent : Microsoft.SqlServer.Dts.Runtime.TaskHost * string * string * Object[] * string * bool -> unit
override this.OnCustomEvent : Microsoft.SqlServer.Dts.Runtime.TaskHost * string * string * Object[] * string * bool -> unit
Public Overridable Sub OnCustomEvent (taskHost As TaskHost, eventName As String, eventText As String, ByRef arguments As Object(), subComponent As String, ByRef fireAgain As Boolean)

Parameters

taskHost
TaskHost

The task that is hosting the current task.

eventName
String

The name of the event.

eventText
String

The text describing the event.

arguments
Object[]

An array of arguments to pass to the event.

subComponent
String

A string that contains more detail about the event source.

fireAgain
Boolean

A Boolean that indicates whether this should continue firing or stop firing. A value of true indicates that it should continue firing.

Implements

Remarks

OnCustomEvent may be called at any time during the validation or execution of the task. It allows flexibility in the kinds of events that a task may raise.

Applies to