Partager via


EventInfos.Add Méthode

Définition

Ajoute un objet EventInfo à la collection EventInfos actuelle.

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

Paramètres

eventName
String

Nom de l'événement personnalisé.

description
String

Chaîne qui contient une description de l’événement.

allowEventHandlers
Boolean

Valeur booléenne qui indique si l’outil de développement autorise la création d’objets de gestionnaire d’événements pour l’événement. Si la valeur est true, les objets de gestionnaire d’événements peuvent être créés pour l’événement.

parameterNames
String[]

Tableau de paramètres transmis à l'événement.

parameterTypes
TypeCode[]

Type de chaque paramètre dans le tableau parameterNames.

parameterDescriptions
String[]

Tableau qui contient des descriptions pour chacun des paramètres dans parameterNames.

Exemples

L’exemple suivant montre un événement personnalisé ajouté à la EventInfos collection.

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  

Remarques

Pour obtenir un exemple de collection EventInfos et de Addméthode, consultez Développement d’une tâche personnalisée.

S’applique à