EventInfos Class

Article
04/26/2013

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
	Count	Gets the number of elements contained in the DTSReadOnlyCollectionBase instance. (Inherited from DTSReadOnlyCollectionBase.)
	IsSynchronized	Gets a value that indicates whether access to the DTSReadOnlyCollectionBase is synchronized (thread-safe). (Inherited from DTSReadOnlyCollectionBase.)
	Item	Returns the EventInfo object from the collection.
	SyncRoot	Gets an object that can be used to synchronize access to the DTSReadOnlyCollectionBase. (Inherited from DTSReadOnlyCollectionBase.)

Top

Methods

	Name	Description
	Add	Adds an EventInfo object to the current EventInfos collection.
	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.
	CopyTo	Copies the entire DTSReadOnlyCollectionBase to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from DTSReadOnlyCollectionBase.)
	Equals	(Inherited from Object.)
	GetEnumerator	Returns an enumerator for use in iterating over the EventInfos collection.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Remove	Removes an EventInfo object from the EventInfos collection.
	ToString	(Inherited from Object.)

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.

Share via