IDTSComponentEvents.FireCustomEvent 方法

定义

命名空间:

Microsoft.SqlServer.Dts.Runtime

程序集:

Microsoft.SqlServer.ManagedDTS.dll

在任务引发自定义的任务定义事件时发生。

public:
 void FireCustomEvent(System::String ^ eventName, System::String ^ eventText, cli::array <System::Object ^> ^ % arguments, System::String ^ subComponent, bool % fireAgain);

public void FireCustomEvent (string eventName, string eventText, ref object[] arguments, string subComponent, ref bool fireAgain);

abstract member FireCustomEvent : string * string * Object[] * string * bool -> unit

Public Sub FireCustomEvent (eventName As String, eventText As String, ByRef arguments As Object(), subComponent As String, ByRef fireAgain As Boolean)

参数

eventName

String

要引发的事件的名称。

eventText

String

描述事件的文本。

arguments

Object[]

传递到事件的参数数组。

subComponent

String

一个包含有关事件源的详细信息的字符串。

fireAgain

Boolean

一个布尔值，指示这应该继续触发或停止触发。 true 值指示它应继续激发。

注解

由于触发事件可能很昂贵，因此运行时引擎提供了一种用于抑制你不感兴趣的事件的机制。 每个事件激发方法都有一个 FireAgain 参数。 如果此变量的值是 false，则在方法返回之后，调用方不会在当前执行期间再次触发此事件。

其中几个事件具有一个 subComponent 参数，该参数允许在事件源标识中实现更大的粒度。