ForEachFromVarEnumerator Class

 

This enumerator is used to loop over the objects that are in the variable specified in VariableName.

Namespace:   Microsoft.SqlServer.Dts.Runtime.Enumerators.FromVar
Assembly:  Microsoft.SqlServer.ForEachFromVarEnumerator (in Microsoft.SqlServer.ForEachFromVarEnumerator.dll)

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.ForEachEnumerator
      Microsoft.SqlServer.Dts.Runtime.Enumerators.FromVar.ForEachFromVarEnumerator

public sealed class ForEachFromVarEnumerator : ForEachEnumerator, 
	IDTSComponentPersist, IDTSForEachFromVarEnumerator

NameDescription
System_CAPS_pubmethodForEachFromVarEnumerator()

Initializes a new instance of the ForEachFromVarEnumerator class.

NameDescription
System_CAPS_pubpropertyCollectionEnumerator

Gets or sets Boolean that indicates if the foreach loop enumerator is enumerating collections of objects or enumerating collections of collections.(Inherited from ForEachEnumerator.)

System_CAPS_pubpropertyTargetServerVersion

(Inherited from ForEachEnumerator.)

System_CAPS_pubpropertyVariableName

Gets or sets the name of the variable to enumerate.

System_CAPS_pubpropertyVersion

Returns the version number of the package. This property is read-only. (Inherited from ForEachEnumerator.)

NameDescription
System_CAPS_pubmethodCanUpdate(String)

A Boolean that indicates if the new package XML can update the old package XML.(Inherited from ForEachEnumerator.)

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_pubmethodGetEnumerator(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)

Returns an enumerator that can iterate over the ForEachFromVarEnumerator instance.(Overrides ForEachEnumerator.GetEnumerator(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging).)

System_CAPS_pubmethodGetHashCode()

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

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeForEachEnumerator(Connections, IDTSInfoEvents, ObjectReferenceTracker)

Initializes the properties associated with the task. This method is called by the runtime and is not used in code.(Inherited from ForEachEnumerator.)

System_CAPS_pubmethodLoadFromXML(XmlElement, IDTSInfoEvents)

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, IDTSInfoEvents)

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

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

This method updates the old package XML with the new package XML if CanUpdate is set to true.(Inherited from ForEachEnumerator.)

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)

Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.(Inherited from ForEachEnumerator.)

An example of the use of this enumerator is when a query is run, and the result of the query is stored in the variable. You can use this enumerator to loop over the query results.

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: