ForEachNodeListEnumerator Class

Article
04/26/2013

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

Top

Properties

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