ForEachEnumeratorHost Class

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Dts.Runtime
Assembly:
Microsoft.SqlServer.ManagedDTS.dll

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

public ref class ForEachEnumeratorHost sealed : Microsoft::SqlServer::Dts::Runtime::DtsObject, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionPath, Microsoft::SqlServer::Dts::Runtime::IDTSForEachEnumerator, Microsoft::SqlServer::Dts::Runtime::IDTSName, Microsoft::SqlServer::Dts::Runtime::IDTSObjectHost, Microsoft::SqlServer::Dts::Runtime::IDTSPackagePath, Microsoft::SqlServer::Dts::Runtime::IDTSPersist, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProvider, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProviderEx
public sealed class ForEachEnumeratorHost : Microsoft.SqlServer.Dts.Runtime.DtsObject, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionPath, Microsoft.SqlServer.Dts.Runtime.IDTSForEachEnumerator, Microsoft.SqlServer.Dts.Runtime.IDTSName, Microsoft.SqlServer.Dts.Runtime.IDTSObjectHost, Microsoft.SqlServer.Dts.Runtime.IDTSPackagePath, Microsoft.SqlServer.Dts.Runtime.IDTSPersist, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProvider, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProviderEx
type ForEachEnumeratorHost = class
    inherit DtsObject
    interface IDTSName
    interface IDTSPersist
    interface IDTSObjectHost
    interface IDTSForEachEnumerator
    interface IDTSPropertiesProvider
    interface IDTSPropertiesProviderEx
    interface IDTSPackagePath
    interface IDTSExecutionPath
Public NotInheritable Class ForEachEnumeratorHost
Inherits DtsObject
Implements IDTSExecutionPath, IDTSForEachEnumerator, IDTSName, IDTSObjectHost, IDTSPackagePath, IDTSPersist, IDTSPropertiesProvider, IDTSPropertiesProviderEx
Inheritance
Object
DtsObject
ForEachEnumeratorHost
Implements
IDTSExecutionPath IDTSForEachEnumerator IDTSName IDTSObjectHost IDTSPackagePath IDTSPersist IDTSPropertiesProvider IDTSPropertiesProviderEx

Properties

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.

Methods

Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
GetEnumerator(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)

Returns an IEnumerator interface for use in iterating over the ForEachEnumerator.
GetExecutionPath()

Gets the execution path for the ForEachEnumeratorHost object.
GetExpression(String)

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.
LoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.
SaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.
SetExpression(String, String)

Assigns the specified expression to the property. Specify null to remove an existing expression from the property.
Validate(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)

Allows the host to determine if there are invalid settings that will prevent the ForEachEnumerator from executing successfully.

Applies to