EventInfos.Add Method

Статья
12/15/2008

Adds an EventInfo object to the current EventInfos collection.

Пространство имен: Microsoft.SqlServer.Dts.Runtime
Сборка: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Синтаксис

'Декларация
Public Sub Add ( _
    eventName As String, _
    description As String, _
    allowEventHandlers As Boolean, _
    parameterNames As String(), _
    parameterTypes As TypeCode(), _
    parameterDescriptions As String() _
)

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
)

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

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

Параметры

eventName
The name of the custom event.

description
A String that contains a description of the event.

allowEventHandlers
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
An array of parameters passed to the event.

parameterTypes
The type of each parameter in the parameterNames array.

parameterDescriptions
An array that contains descriptions for each of the parameters in parameterNames.

Замечания

For an example of the EventInfos collection and the Addmethod, see Developing a Custom Task.

Пример

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

Синхронизация потоков

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Платформы

Платформы разработки

Список поддерживаемых платформ см. в разделе Hardware and Software Requirements for Installing SQL Server 2005.

Целевые платформы