Método EventInfos.Add

Artigo
04/26/2013

Adds an EventInfo object to the current EventInfos collection.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (em Microsoft.SqlServer.ManagedDTS.dll)

Sintaxe

'Declaração
Public Sub Add ( _
    eventName As String, _
    description As String, _
    allowEventHandlers As Boolean, _
    parameterNames As String(), _
    parameterTypes As TypeCode(), _
    parameterDescriptions As String() _
)
'Uso
Dim instance As EventInfos 
Dim eventName As String 
Dim description As String 
Dim allowEventHandlers As Boolean 
Dim parameterNames As String()
Dim parameterTypes As TypeCode()
Dim parameterDescriptions As String()

instance.Add(eventName, description, allowEventHandlers, _
    parameterNames, parameterTypes, _
    parameterDescriptions)

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

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

member Add : 
        eventName:string * 
        description:string * 
        allowEventHandlers:bool * 
        parameterNames:string[] * 
        parameterTypes:TypeCode[] * 
        parameterDescriptions:string[] -> unit

public function Add(
    eventName : String, 
    description : String, 
    allowEventHandlers : boolean, 
    parameterNames : String[], 
    parameterTypes : TypeCode[], 
    parameterDescriptions : String[]
)

Parâmetros

eventName
Tipo: System.String
The name of the custom event.

description
Tipo: System.String
A String that contains a description of the event.

allowEventHandlers
Tipo: System.Boolean
A Boolean that indicates if the development tool will allow event handler objects to be created for the event. If true, event handler objects can be created for the event.

parameterNames
Tipo: array<System.String[]
An array of parameters passed to the event.

parameterTypes
Tipo: array<System.TypeCode[]
The type of each parameter in the parameterNames array.

parameterDescriptions
Tipo: array<System.String[]
An array that contains descriptions for each of the parameters in parameterNames.

Comentários

For an example of the EventInfos collection and the Addmethod, see Desenvolvendo uma tarefa personalizada.

Exemplos

The following example shows a custom event being added to the 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

Consulte também

Referência

EventInfos Classe

Namespace Microsoft.SqlServer.Dts.Runtime

Compartilhar via