XPathNodeIterator.GetEnumerator Method

Definition

Namespace:

System.Xml.XPath

Assembly:

System.Xml.ReaderWriter.dll

Source:

XPathNodeIterator.cs

Returns an IEnumerator object to iterate through the selected node set.

public:
 virtual System::Collections::IEnumerator ^ GetEnumerator();

public virtual System.Collections.IEnumerator GetEnumerator ();

abstract member GetEnumerator : unit -> System.Collections.IEnumerator
override this.GetEnumerator : unit -> System.Collections.IEnumerator

Public Overridable Function GetEnumerator () As IEnumerator

Returns

IEnumerator

An IEnumerator object to iterate through the selected node set.

Implements

GetEnumerator()

Remarks

The enumerator is positioned on the current position of the XPathNodeIterator object.

There are two ways to iterate over an XPathNavigator collection by using the XPathNodeIterator class.

One way is to use the MoveNext method and then call Current to get the current XPathNavigator instance, as in the following example:

while (nodeIterator->MoveNext())
{
    XPathNavigator^ n = nodeIterator->Current;
Console::WriteLine(n->LocalName);
}

while (nodeIterator.MoveNext())
{
    XPathNavigator n = nodeIterator.Current;
    Console.WriteLine(n.LocalName);
}

While nodeIterator.MoveNext()
    Dim n As XPathNavigator = nodeIterator.Current
    Console.WriteLine(n.LocalName)
End While

Another way is to use a foreach loop to call the GetEnumerator method and use the returned IEnumerator interface to enumerate the nodes, as in the following example:

for each (XPathNavigator^ n in nodeIterator)
Console::WriteLine(n->LocalName);

foreach (XPathNavigator n in nodeIterator)
    Console.WriteLine(n.LocalName);

For Each n As XPathNavigator In nodeIterator
    Console.WriteLine(nav.LocalName)
Next

You should either use the MoveNext method and Current or use the GetEnumerator method. Combining these two approaches can cause unexpected results. For example, if the MoveNext method is called first, and then the GetEnumerator method is called in the foreach loop, the foreach loop will not start enumerating the results from the beginning of the collection, but from the position after the Current method.

See also

• IEnumerator