Share via

ForEachSchemaRowsetEnumerator Class

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
Public method ForEachSchemaRowsetEnumerator Initializes a new instance of the ForEachSchemaRowsetEnumerator class.

Top

Properties

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

Top

Methods

  Name Description
Public method CanUpdate A Boolean that indicates if the new package XML can update the old package XML. (Inherited from ForEachEnumerator.)
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Protected method Finalize (Inherited from Object.)
Public method GetEnumerator Returns an enumerator for iterating over the collection. (Overrides ForEachEnumerator.GetEnumerator(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging).)
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Public method InitializeForEachEnumerator Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Inherited from ForEachEnumerator.)
Public method LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected method MemberwiseClone (Inherited from Object.)
Public method SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public method ToString (Inherited from Object.)
Public method Update This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from ForEachEnumerator.)
Public method 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.