Export (0) Print
Expand All

ForEachEnumeratorHost Class

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


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

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

The ForEachEnumeratorHost type exposes the following members.

Public propertyCollectionEnumeratorGets or sets a Boolean that indicates if the hosting enumerator is enumerating collections of objects or enumerating collections of collections.
Public propertyCreationNameReturns the string that is used by the run-time to create an instance of the ForEachEnumeratorHost object. This property is read-only.
Public propertyDelayValidationGets or sets a Boolean that indicates whether ForEachEnumerator validation is delayed until the package runs.
Public propertyDescriptionGets or sets description for the host.
Public propertyHasExpressionsGets a value that indicates whether the ForEachEnumeratorHost object has expressions.
Public propertyHostTypeGets an enumeration that describes the type of host that the ForEachEnumerator is being used by. This property is read-only
Public propertyIDReturns the GUID assigned to the host.
Public propertyInnerObjectReturns the inner object of the host, which is the ForEachEnumerator that is being hosted.
Public propertyNameGets or sets a name for the host.
Public propertyPropertiesReturns a DtsProperties collection that contains DtsProperty objects. Each DtsProperty has additional information about each task in the ForEachEnumeratorHost.

Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodGetEnumeratorReturns an IEnumerator interface for use in iterating over the ForEachEnumerator.
Public methodGetExecutionPathGets the execution path for the ForEachEnumeratorHost object.
Public methodGetExpressionReturns a String that contains the expression for the specified property. Null means no expression is assigned.
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetPackagePathGets the package path for the ForEachEnumeratorHost object.
Public methodGetType (Inherited from Object.)
Public methodLoadFromXMLThis method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Public methodSaveToXMLThis method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public methodSetExpressionAssigns the specified expression to the property. Specify null to remove an existing expression from the property.
Public methodToString (Inherited from Object.)
Public methodValidateAllows the host to determine if there are invalid settings that will prevent the ForEachEnumerator from executing successfully.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2015 Microsoft