Share via


ForEachNodeListEnumerator Class

Defines a class used to enumerate a set of XML nodes that result from applying an XPath expession to an XML file.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.ForEachEnumerator
      Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList.ForEachNodeListEnumerator

Namespace:  Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList
Assembly:  Microsoft.SqlServer.ForEachNodeListEnumerator (in Microsoft.SqlServer.ForEachNodeListEnumerator.dll)

Syntax

'Declaration
Public NotInheritable Class ForEachNodeListEnumerator _
    Inherits ForEachEnumerator _
    Implements IDTSForEachNodeListEnumerator, IDTSComponentPersist
'Usage
Dim instance As ForEachNodeListEnumerator
public sealed class ForEachNodeListEnumerator : ForEachEnumerator, 
    IDTSForEachNodeListEnumerator, IDTSComponentPersist
public ref class ForEachNodeListEnumerator sealed : public ForEachEnumerator, 
    IDTSForEachNodeListEnumerator, IDTSComponentPersist
[<SealedAttribute>]
type ForEachNodeListEnumerator =  
    class 
        inherit ForEachEnumerator 
        interface IDTSForEachNodeListEnumerator 
        interface IDTSComponentPersist 
    end
public final class ForEachNodeListEnumerator extends ForEachEnumerator implements IDTSForEachNodeListEnumerator, IDTSComponentPersist

The ForEachNodeListEnumerator type exposes the following members.

Constructors

  Name Description
Public method ForEachNodeListEnumerator Initializes a new instance of the ForEachNodeListEnumerator class.

Top

Properties

  Name Description
Public property CollectionEnumerator Returns a Boolean indicating whether the enumerator type is an element collection. (Overrides ForEachEnumerator.CollectionEnumerator.)
Public property EnumerationType Gets or sets this property to a value from the EnumerationType enumeration.
Public property InnerElementType Gets or sets this property to a value from the InnerElementType enumeration.
Public property InnerXPathString Specifies the XPath string, or the name of the variable containing the XPath string, depending on the value of InnerXPathStringSourceType.
Public property InnerXPathStringSourceType Gets or sets the source type of the inner XPath string using values from the SourceType enumeration.
Public property NodeList Gets an ArrayList class that contains a collection of nodes that the XPath operation produces.
Public property OuterXPathString Get or sets a value that represents either the XPath string, the name of the file containing the XPath string, or the name of the variable containing the XPath string, depending on the value of OuterXPathStringSourceType.
Public property OuterXPathStringSourceType Gets or sets the source type of the XPath string, using values in the SourceType enumeration.
Public property SourceDocument Gets or sets a value that represents either the XML source document as a string, the name of the file containing the XML source document, or the name of the variable containing the XML source document, depending on the value of SourceDocumentType.
Public property SourceDocumentType Gets or sets the type of source that the source document is, using the SourceType enumerator.
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 ForEachNodeListEnumerator 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 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.

See Also

Reference

Microsoft.SqlServer.Dts.Runtime.Enumerators.NodeList Namespace