EventInfos.Add 方法

定义

命名空间:

Microsoft.SqlServer.Dts.Runtime

程序集:

Microsoft.SqlServer.ManagedDTS.dll

将 EventInfo 对象添加到当前的 EventInfos 集合。

public:
 void Add(System::String ^ eventName, System::String ^ description, bool allowEventHandlers, cli::array <System::String ^> ^ parameterNames, cli::array <TypeCode> ^ parameterTypes, cli::array <System::String ^> ^ parameterDescriptions);

public void Add (string eventName, string description, bool allowEventHandlers, string[] parameterNames, TypeCode[] parameterTypes, string[] parameterDescriptions);

member this.Add : string * string * bool * string[] * TypeCode[] * string[] -> unit

Public Sub Add (eventName As String, description As String, allowEventHandlers As Boolean, parameterNames As String(), parameterTypes As TypeCode(), parameterDescriptions As String())

参数

eventName

String

自定义事件的名称。

description

String

包含事件说明的字符串。

allowEventHandlers

Boolean

一个布尔值，指示开发工具是否允许为事件创建事件处理程序对象。 如果为 true，则可以为事件创建事件处理程序对象。

parameterNames

String[]

传递到事件的参数数组。

parameterTypes

TypeCode[]

parameterNames 数组中每个参数的类型。

parameterDescriptions

String[]

一个数组，该数组包含 parameterNames 中每个参数的说明。

示例

下面的示例演示要添加到集合中的 EventInfos 自定义事件。

public override void InitializeTask(Connections connections, VariableDispenser variables, IDTSInfoEvents events, IDTSLogging log, EventInfos eventInfos, LogEntryInfos logEntryInfos, ObjectReferenceTracker refTracker)  
{  
    this.eventInfos = eventInfos;  
    string[] paramNames = new string[1];  
    TypeCode[] paramTypes = new TypeCode[1]{TypeCode.Int32};  
    string[] paramDescriptions = new string[1];  

    paramNames[0] = "InitialValue";  
    paramDescriptions[0] = "The value before increment.";  

    this.eventInfos.Add("OnBeforeIncrement","Fires before the task increments the value.",true,paramNames,paramTypes,paramDescriptions);  
    this.onBeforeIncrement = this.eventInfos["OnBeforeIncrement"];  

    paramDescriptions[0] = "The value after increment.";  
    this.eventInfos.Add("OnAfterIncrement","Fires after the initial value is updated.",true,paramNames, paramTypes,paramDescriptions);  
    this.onAfterIncrement = this.eventInfos["OnAfterIncrement"];  
}  

Public Overrides Sub InitializeTask(ByVal connections As Connections, ByVal variables As VariableDispenser, ByVal events As IDTSInfoEvents, ByVal log As IDTSLogging, ByVal eventInfos As EventInfos, ByVal logEntryInfos As LogEntryInfos, ByVal refTracker As ObjectReferenceTracker)   
    Me.eventInfos = eventInfos  
    Dim paramNames(0) As String  
    Dim paramTypes(0) As TypeCode = {TypeCode.Int32}  
    Dim paramDescriptions(0) As String  

    paramNames(0) = "InitialValue"  
    paramDescriptions(0) = "The value before increment."  

    Me.eventInfos.Add("OnBeforeIncrement", "Fires before the task increments the value.", True, paramNames, paramTypes, paramDescriptions)  
    Me.onBeforeIncrement = Me.eventInfos("OnBeforeIncrement")  

    paramDescriptions(0) = "The value after increment."  
    Me.eventInfos.Add("OnAfterIncrement", "Fires after the initial value is updated.", True, paramNames, paramTypes, paramDescriptions)  
    Me.onAfterIncrement = Me.eventInfos("OnAfterIncrement")  
End Sub  

注解

有关集合和Add方法的示例EventInfos，请参阅开发自定义任务。