ForEachSchemaRowsetEnumerator Class

Article
04/26/2013

Contains the methods and properties for implementing a Foreach loop that enumerates over a schema rowset. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.ForEachEnumerator
      Microsoft.SqlServer.Dts.Runtime.Enumerators.ADO.ForEachSchemaRowsetEnumerator

Namespace: Microsoft.SqlServer.Dts.Runtime.Enumerators.ADO
Assembly: Microsoft.SqlServer.ForEachADOEnumerator (in Microsoft.SqlServer.ForEachADOEnumerator.dll)

Syntax

'Declaration
<DtsForEachEnumeratorAttribute(LocalizationType := GetType(ForEachSchemaRowsetEnumerator), UITypeName := "Microsoft.SqlServer.Dts.Runtime.Enumerators.ADO.ForEachSchemaRowsetEnumeratorUI, Microsoft.SqlServer.ForEachADOEnumeratorUI, Version={0}, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")> _
Public NotInheritable Class ForEachSchemaRowsetEnumerator _
    Inherits ForEachEnumerator _
    Implements IDTSForEachSchemaRowsetEnumerator, IDTSComponentPersist
'Usage
Dim instance As ForEachSchemaRowsetEnumerator

[DtsForEachEnumeratorAttribute(LocalizationType = typeof(ForEachSchemaRowsetEnumerator), UITypeName = "Microsoft.SqlServer.Dts.Runtime.Enumerators.ADO.ForEachSchemaRowsetEnumeratorUI, Microsoft.SqlServer.ForEachADOEnumeratorUI, Version={0}, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class ForEachSchemaRowsetEnumerator : ForEachEnumerator, 
    IDTSForEachSchemaRowsetEnumerator, IDTSComponentPersist

[DtsForEachEnumeratorAttribute(LocalizationType = typeof(ForEachSchemaRowsetEnumerator), UITypeName = L"Microsoft.SqlServer.Dts.Runtime.Enumerators.ADO.ForEachSchemaRowsetEnumeratorUI, Microsoft.SqlServer.ForEachADOEnumeratorUI, Version={0}, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public ref class ForEachSchemaRowsetEnumerator sealed : public ForEachEnumerator, 
    IDTSForEachSchemaRowsetEnumerator, IDTSComponentPersist

[<SealedAttribute>]
[<DtsForEachEnumeratorAttribute(LocalizationType = typeof(ForEachSchemaRowsetEnumerator), UITypeName = "Microsoft.SqlServer.Dts.Runtime.Enumerators.ADO.ForEachSchemaRowsetEnumeratorUI, Microsoft.SqlServer.ForEachADOEnumeratorUI, Version={0}, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type ForEachSchemaRowsetEnumerator =  
    class 
        inherit ForEachEnumerator 
        interface IDTSForEachSchemaRowsetEnumerator 
        interface IDTSComponentPersist 
    end

public final class ForEachSchemaRowsetEnumerator extends ForEachEnumerator implements IDTSForEachSchemaRowsetEnumerator, IDTSComponentPersist

The ForEachSchemaRowsetEnumerator type exposes the following members.

Constructors

	Name	Description
	ForEachSchemaRowsetEnumerator	Initializes a new instance of the ForEachSchemaRowsetEnumerator class.

Top

Properties

	Name	Description
	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.)
	Connection	Gets or sets a String that contains the connection information for the schema rowset enumerator.
	ForEachEnumeratorDescription	Returns a description for the ForEachSchemaRowsetEnumerator.
	ForEachEnumeratorDisplayName	Gets or sets a String that contains the display name for the enumerator.
	Restrictions	Gets or sets an array of Strings that contains the restrictions to apply to the rowset that is returned.
	SchemaRowset	Gets or sets the GUID of the schema
	Version	Returns the version number of the package. This property is read-only. (Inherited from ForEachEnumerator.)

Top

Methods

	Name	Description
	CanUpdate	A Boolean that indicates if the new package XML can update the old package XML. (Inherited from ForEachEnumerator.)
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	GetEnumerator	Returns an enumerator for iterating over the collection. (Overrides ForEachEnumerator.GetEnumerator(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging).)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	InitializeForEachEnumerator	Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Inherited from ForEachEnumerator.)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
	ToString	(Inherited from Object.)
	Update	This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from ForEachEnumerator.)
	Validate	Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Inherited from ForEachEnumerator.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via