• Article

EventInfos Class

Contains a collection of EventInfo objects. The run-time engine exposes an EventInfos collection on all containers in the package hierarchy. The collection that a task receives is a reference to EventInfos collection on the TaskHost that is wrapping the task. Other containers' EventInfos collections contain aggregated contents of their children’s EventInfos collections. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DTSReadOnlyCollectionBase
    Microsoft.SqlServer.Dts.Runtime.EventInfos

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

Syntax

'Declaration
Public NotInheritable Class EventInfos _
    Inherits DTSReadOnlyCollectionBase
'Usage
Dim instance As EventInfos

public sealed class EventInfos : DTSReadOnlyCollectionBase

public ref class EventInfos sealed : public DTSReadOnlyCollectionBase

[<SealedAttribute>]
type EventInfos =  
    class
        inherit DTSReadOnlyCollectionBase
    end

public final class EventInfos extends DTSReadOnlyCollectionBase

The EventInfos type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of elements contained in the DTSReadOnlyCollectionBase instance. (Inherited from DTSReadOnlyCollectionBase.)
Public property IsSynchronized Gets a value that indicates whether access to the DTSReadOnlyCollectionBase is synchronized (thread-safe). (Inherited from DTSReadOnlyCollectionBase.)
Public property Item Returns the EventInfo object from the collection.
Public property SyncRoot Gets an object that can be used to synchronize access to the DTSReadOnlyCollectionBase. (Inherited from DTSReadOnlyCollectionBase.)

Top

Methods

  Name Description
Public method Add Adds an EventInfo object to the current EventInfos collection.
Public method Contains Returns a Boolean that indicates whether the items in the collection can be accessed using the name, description, ID, or index as the index.
Public method CopyTo Copies the entire DTSReadOnlyCollectionBase to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from DTSReadOnlyCollectionBase.)
Protected method CreateManagedObject Infrastructure. (Inherited from DTSReadOnlyCollectionBase.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetCount Infrastructure. (Inherited from DTSReadOnlyCollectionBase.)
Public method GetEnumerator Returns an enumerator for use in iterating over the EventInfos collection.
Public method GetHashCode (Inherited from Object.)
Protected method GetManagedEnumerator Infrastructure. (Inherited from DTSReadOnlyCollectionBase.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Remove Removes an EventInfo object from the EventInfos collection.
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
Protected field m_unmanagedColl Infrastructure. (Inherited from DTSReadOnlyCollectionBase.)

Top

Remarks

The EventInfos collection is used to hold custom events and events that you want the task to raise during execution. When creating a custom task, use this class to add your own custom events to the runtime.

Thread Safety

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