ForEachEnumeratorHost Class

Defines the host class for the ForEachEnumerator. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.ForEachEnumeratorHost

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

Syntax

'Declaration
Public NotInheritable Class ForEachEnumeratorHost _
    Inherits DtsObject _
    Implements IDTSName, IDTSPersist, IDTSObjectHost, IDTSForEachEnumerator,  _
    IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath
'Usage
Dim instance As ForEachEnumeratorHost

public sealed class ForEachEnumeratorHost : DtsObject, 
    IDTSName, IDTSPersist, IDTSObjectHost, IDTSForEachEnumerator, IDTSPropertiesProvider, 
    IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath

public ref class ForEachEnumeratorHost sealed : public DtsObject, 
    IDTSName, IDTSPersist, IDTSObjectHost, IDTSForEachEnumerator, IDTSPropertiesProvider, 
    IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath

[<SealedAttribute>]
type ForEachEnumeratorHost =  
    class 
        inherit DtsObject 
        interface IDTSName 
        interface IDTSPersist 
        interface IDTSObjectHost 
        interface IDTSForEachEnumerator 
        interface IDTSPropertiesProvider 
        interface IDTSPropertiesProviderEx 
        interface IDTSPackagePath 
        interface IDTSExecutionPath 
    end

public final class ForEachEnumeratorHost extends DtsObject implements IDTSName, IDTSPersist, IDTSObjectHost, IDTSForEachEnumerator, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath

The ForEachEnumeratorHost type exposes the following members.

Properties

	Name	Description
	CollectionEnumerator	Gets or sets a Boolean that indicates if the hosting enumerator is enumerating collections of objects or enumerating collections of collections.
	CreationName	Returns the string that is used by the run-time to create an instance of the ForEachEnumeratorHost object. This property is read-only.
	DelayValidation	Gets or sets a Boolean that indicates whether ForEachEnumerator validation is delayed until the package runs.
	Description	Gets or sets description for the host.
	HasExpressions	Gets a value that indicates whether the ForEachEnumeratorHost object has expressions.
	HostType	Gets an enumeration that describes the type of host that the ForEachEnumerator is being used by. This property is read-only
	ID	Returns the GUID assigned to the host.
	InnerObject	Returns the inner object of the host, which is the ForEachEnumerator that is being hosted.
	Name	Gets or sets a name for the host.
	Properties	Returns a DtsProperties collection that contains DtsProperty objects. Each DtsProperty has additional information about each task in the ForEachEnumeratorHost.

Top

Methods

	Name	Description
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	GetEnumerator	Returns an IEnumerator interface for use in iterating over the ForEachEnumerator.
	GetExecutionPath	Gets the execution path for the ForEachEnumeratorHost object.
	GetExpression	Returns a String that contains the expression for the specified property. Null means no expression is assigned.
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetPackagePath	Gets the package path for the ForEachEnumeratorHost object.
	GetType	(Inherited from Object.)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
	SetExpression	Assigns the specified expression to the property. Specify nulla null reference (Nothing in Visual Basic) to remove an existing expression from the property.
	ToString	(Inherited from Object.)
	Validate	Allows the host to determine if there are invalid settings that will prevent the ForEachEnumerator from executing successfully.

Top

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.

See Also

Reference

Microsoft.SqlServer.Dts.Runtime Namespace