ForEachSMOEnumerator Class

  • Article

Contains the members used when enumerating over SQL Server Management Objects (SMO). This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.ForEachEnumerator
      Microsoft.SqlServer.Dts.Runtime.Enumerators.SMO.ForEachSMOEnumerator

Namespace:  Microsoft.SqlServer.Dts.Runtime.Enumerators.SMO
Assembly:  Microsoft.SqlServer.ForEachSMOEnumerator (in Microsoft.SqlServer.ForEachSMOEnumerator.dll)

Syntax

'Declaration
Public NotInheritable Class ForEachSMOEnumerator _
    Inherits ForEachEnumerator _
    Implements IDTSComponentPersist, IDTSForEachSMOEnumerator
'Usage
Dim instance As ForEachSMOEnumerator

public sealed class ForEachSMOEnumerator : ForEachEnumerator, 
    IDTSComponentPersist, IDTSForEachSMOEnumerator

public ref class ForEachSMOEnumerator sealed : public ForEachEnumerator, 
    IDTSComponentPersist, IDTSForEachSMOEnumerator

[<SealedAttribute>]
type ForEachSMOEnumerator =  
    class 
        inherit ForEachEnumerator 
        interface IDTSComponentPersist 
        interface IDTSForEachSMOEnumerator 
    end

public final class ForEachSMOEnumerator extends ForEachEnumerator implements IDTSComponentPersist, IDTSForEachSMOEnumerator

The ForEachSMOEnumerator type exposes the following members.

Constructors

  Name Description
Public method ForEachSMOEnumerator Initializes a new instance of the ForEachSMOEnumerator 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 EnumURN Gets or sets a String that contains the SMO enumeration Uniform Resource Name (URN) for the selected enumeration.
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.)
Public method GetEnumerator Returns an enumerator that can iterate through the ForEachSMOEnumerator instance. (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.
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 Returns a value that indicates whether the container has invalid settings that will prevent it from running successfully. (Overrides ForEachEnumerator.Validate(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging).)

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.

See Also

Reference

Microsoft.SqlServer.Dts.Runtime.Enumerators.SMO Namespace