ForEachFromVarEnumerator Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime.Enumerators.FromVar

Assembly:: Microsoft.SqlServer.ForEachFromVarEnumerator.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class ForEachFromVarEnumerator sealed : Microsoft::SqlServer::Dts::Runtime::ForEachEnumerator, Microsoft::SqlServer::Dts::Runtime::Enumerators::FromVar::IDTSForEachFromVarEnumerator, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist

[Microsoft.SqlServer.Dts.Runtime.DtsForEachEnumerator(LocalizationType=typeof(Microsoft.SqlServer.Dts.Runtime.Enumerators.FromVar.Localized), UITypeName="Microsoft.SqlServer.Dts.Runtime.Enumerators.FromVar.ForEachFromVarEnumeratorUI, Microsoft.SqlServer.ForEachFromVarEnumeratorUI, Version={0}, Culture=neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class ForEachFromVarEnumerator : Microsoft.SqlServer.Dts.Runtime.ForEachEnumerator, Microsoft.SqlServer.Dts.Runtime.Enumerators.FromVar.IDTSForEachFromVarEnumerator, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist

[<Microsoft.SqlServer.Dts.Runtime.DtsForEachEnumerator(LocalizationType=typeof(Microsoft.SqlServer.Dts.Runtime.Enumerators.FromVar.Localized), UITypeName="Microsoft.SqlServer.Dts.Runtime.Enumerators.FromVar.ForEachFromVarEnumeratorUI, Microsoft.SqlServer.ForEachFromVarEnumeratorUI, Version={0}, Culture=neutral, PublicKeyToken=89845dcd8080cc91")>]
type ForEachFromVarEnumerator = class
    inherit ForEachEnumerator
    interface IDTSComponentPersist
    interface IDTSForEachFromVarEnumerator

Public NotInheritable Class ForEachFromVarEnumerator
Inherits ForEachEnumerator
Implements IDTSComponentPersist, IDTSForEachFromVarEnumerator

Inheritance: Object

DtsObject

ForEachEnumerator
ForEachFromVarEnumerator

Attributes: DtsForEachEnumeratorAttribute

Implements: IDTSForEachFromVarEnumerator IDTSComponentPersist

Remarks

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.

Constructors

ForEachFromVarEnumerator()

Initializes a new instance of the ForEachFromVarEnumerator class.

Properties

CollectionEnumerator	Gets or sets Boolean that indicates if the foreach loop enumerator is enumerating collections of objects or enumerating collections of collections. (Inherited from ForEachEnumerator)
TargetServerVersion	(Inherited from ForEachEnumerator)
VariableName	Gets or sets the name of the variable to enumerate.
Version	Returns the version number of the package. This property is read-only. (Inherited from ForEachEnumerator)

Methods

CanUpdate(String)	A Boolean that indicates if the new package XML can update the old package XML. (Inherited from ForEachEnumerator)
Equals(Object)	Determines whether two object instances are equal. (Inherited from DtsObject)
GetEnumerator(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)	Returns an IEnumerator interface that can iterate over the ActiveX Data Objects (ADO) object.
GetHashCode()	Returns the hash code for this instance. (Inherited from DtsObject)
InitializeForEachEnumerator(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)
LoadFromXML(XmlElement, IDTSInfoEvents)	This method is not callable by your application code. To load a package that is saved as .xml to the hard drive, use the LoadPackage(String, IDTSEvents) method.
SaveToXML(XmlDocument, IDTSInfoEvents)	This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.
Update(String)	This method updates the old package XML with the new package XML if CanUpdate(String) is set to true. (Inherited from ForEachEnumerator)
Validate(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)	Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Inherited from ForEachEnumerator)

Applies to

Share via