This documentation is archived and is not being maintained.

XmlReader.ReadToDescendant Method (String)

Advances the XmlReader to the next descendant element with the specified qualified name.

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)

Public Overridable Function ReadToDescendant ( _
	name As String _
) As Boolean
Dim instance As XmlReader 
Dim name As String 
Dim returnValue As Boolean 

returnValue = instance.ReadToDescendant(name)


Type: System.String

The qualified name of the element you wish to move to.

Return Value

Type: System.Boolean
true if a matching descendant element is found; otherwise false. If a matching child element is not found, the XmlReader is positioned on the end tag (NodeType is XmlNodeType.EndElement) of the element.
If the XmlReader is not positioned on an element when ReadToDescendant was called, this method returns false and the position of the XmlReader is not changed.

The following example parses the second book node.

Using reader As XmlReader = XmlReader.Create("2books.xml")

  ' Move the reader to the second book node.
  reader.Skip() 'Skip the first book.
  ' Parse the file starting with the second book node.
    Select Case reader.NodeType
      Case XmlNodeType.Element
        Console.Write("<{0}", reader.Name)
        While reader.MoveToNextAttribute()
            Console.Write(" {0}='{1}'", reader.Name, reader.Value)
        End While
      Case XmlNodeType.Text
      Case XmlNodeType.EndElement
        Console.Write("</{0}>", reader.Name)
    End Select 
  Loop While reader.Read()

End Using

The example uses the file, 2books.xml, as input.

<!--sample XML fragment-->
  <book genre='novel' ISBN='10-861003-324'>
    <title>The Handmaid's Tale</title>
  <book genre='novel' ISBN='1-861001-57-5'>
    <title>Pride And Prejudice</title>

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0