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)

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

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

NameDescription
System_CAPS_pubpropertyCollectionEnumerator

Gets or sets a Boolean that indicates if the hosting enumerator is enumerating collections of objects or enumerating collections of collections.

System_CAPS_pubpropertyCreationName

Returns the string that is used by the run-time to create an instance of the ForEachEnumeratorHost object. This property is read-only.

System_CAPS_pubpropertyDelayValidation

Gets or sets a Boolean that indicates whether ForEachEnumerator validation is delayed until the package runs.

System_CAPS_pubpropertyDescription

Gets or sets description for the host.

System_CAPS_pubpropertyHasExpressions

Gets a value that indicates whether the ForEachEnumeratorHost object has expressions.

System_CAPS_pubpropertyHostType

Gets an enumeration that describes the type of host that the ForEachEnumerator is being used by. This property is read-only

System_CAPS_pubpropertyID

Returns the GUID assigned to the host.

System_CAPS_pubpropertyInnerObject

Returns the inner object of the host, which is the ForEachEnumerator that is being hosted.

System_CAPS_pubpropertyName

Gets or sets a name for the host.

System_CAPS_pubpropertyProperties

Returns a DtsProperties collection that contains DtsProperty objects. Each DtsProperty has additional information about each task in the ForEachEnumeratorHost.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodGetEnumerator(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)

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

System_CAPS_pubmethodGetExecutionPath()

Gets the execution path for the ForEachEnumeratorHost object.

System_CAPS_pubmethodGetExpression(String)

Returns a String that contains the expression for the specified property. Null means no expression is assigned.

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetPackagePath()

Gets the package path for the ForEachEnumeratorHost object.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.

System_CAPS_pubmethodSaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSetExpression(String, String)

Assigns the specified expression to the property. Specify null to remove an existing expression from the property.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)

Allows 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.

Return to top
Show: