Sprache

EventInfos.Add Methode

Definition

Namespace:
Microsoft.SqlServer.Dts.Runtime
Assembly:
Microsoft.SqlServer.ManagedDTS.dll

Fügt ein EventInfo Objekt zur aktuellen EventInfos Sammlung hinzu.

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())

Parameter

eventName
String

Der Name des benutzerdefinierten Ereignisses.

description
String

Eine Zeichenkette, die eine Beschreibung des Ereignisses enthält.

allowEventHandlers
Boolean

Ein Boolean, der angibt, ob das Entwicklungstool das Erstellen von Ereignishandlerobjekten für das Ereignis ermöglicht. Falls zutreffend, können Ereignishandler-Objekte für das Ereignis erstellt werden.

parameterNames
String[]

Ein Array von Parametern wurde an das Ereignis weitergegeben.

parameterTypes
TypeCode[]

Der Typ jedes Parameters im Array parameterNames .

parameterDescriptions
String[]

Ein Array, das Beschreibungen für jeden der Parameter in parameterNamesenthält.

Beispiele

Das folgende Beispiel zeigt, wie ein benutzerdefiniertes Ereignis zur Sammlung EventInfos hinzugefügt wird.

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

Hinweise

Ein Beispiel für die EventInfos Sammlung und die Methode Addfinden Sie unter Entwicklung einer benutzerdefinierten Aufgabe.

Gilt für: