Export (0) Print
Expand All

XmlTextReader.Read Method

Reads the next node from the stream.

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

public override bool Read ()
public boolean Read ()
public override function Read () : boolean

Return Value

true if the next node was read successfully; false if there are no more nodes to read.

Exception typeCondition

XmlException

An error occurred while parsing the XML.

NoteNote

In the Microsoft .NET Framework version 2.0 release, the recommended practice is to create XmlReader instances using the System.Xml.XmlReader.Create method. This allows you to take full advantage of the new features introduced in this release. For more information, see Creating XML Readers.

When a reader is first created and initialized, there is no information available. You must call Read to read the first node.

The following example reads an XML file and displays each node.

using System;
using System.IO;
using System.Xml;

public class Sample {

  private const String filename = "items.xml";

  public static void Main() {
  
     XmlTextReader reader = null;

     try {
       
        // Load the reader with the data file and ignore all white space nodes.         
        reader = new XmlTextReader(filename);
        reader.WhitespaceHandling = WhitespaceHandling.None;

        // Parse the file and display each of the nodes.
        while (reader.Read()) {
           switch (reader.NodeType) {
             case XmlNodeType.Element:
               Console.Write("<{0}>", reader.Name);
               break;
             case XmlNodeType.Text:
               Console.Write(reader.Value);
               break;
             case XmlNodeType.CDATA:
               Console.Write("<![CDATA[{0}]]>", reader.Value);
               break;
             case XmlNodeType.ProcessingInstruction:
               Console.Write("<?{0} {1}?>", reader.Name, reader.Value);
               break;
             case XmlNodeType.Comment:
               Console.Write("<!--{0}-->", reader.Value);
               break;
             case XmlNodeType.XmlDeclaration:
               Console.Write("<?xml version='1.0'?>");
               break;
             case XmlNodeType.Document:
               break;
             case XmlNodeType.DocumentType:
               Console.Write("<!DOCTYPE {0} [{1}]", reader.Name, reader.Value);
               break;
             case XmlNodeType.EntityReference:
               Console.Write(reader.Name);
               break;
             case XmlNodeType.EndElement:
               Console.Write("</{0}>", reader.Name);
               break;
           }       
        }           
     }

     finally {
        if (reader!=null)
          reader.Close();
     }
  }
} // End class

import System.*;
import System.IO.*;
import System.Xml.*;

public class Sample
{
    private static String fileName = "items.xml";

    public static void main(String[] args)
    {
        XmlTextReader reader = null;
        try {

            // Load the reader with the data file and ignore 
            //all white space nodes.         
            reader = new XmlTextReader(fileName);
            reader.set_WhitespaceHandling(WhitespaceHandling.None);

            // Parse the file and display each of the nodes.
            while(reader.Read()) {
                switch(reader.get_NodeType() ) {
                    case XmlNodeType.Element : 
                        Console.Write("<{0}>", reader.get_Name());
                        break;
                    case XmlNodeType.Text : 
                        Console.Write(reader.get_Value());
                        break;
                    case XmlNodeType.CDATA : 
                        Console.Write("<![CDATA[{0}]]>", reader.get_Value());
                        break;
                    case XmlNodeType.ProcessingInstruction : 
                        Console.Write("<?{0} {1}?>", reader.get_Name(),
                        reader.get_Value());
                        break;
                    case XmlNodeType.Comment : 
                        Console.Write("<!--{0}-->", reader.get_Value());
                        break;
                    case XmlNodeType.XmlDeclaration : 
                        Console.Write("<?xml version='1.0'?>");
                        break;
                    case XmlNodeType.Document : 
                        break;
                    case XmlNodeType.DocumentType : 
                        Console.Write("<!DOCTYPE {0} [{1}]", reader.get_Name(),
                        reader.get_Value());
                        break;
                    case XmlNodeType.EntityReference : 
                        Console.Write(reader.get_Name());
                        break;
                    case XmlNodeType.EndElement : 
                        Console.Write("</{0}>", reader.get_Name());
                        break;
                }
            }
        }
        finally {
            if (reader != null) {
                reader.Close();
            }
        }
    } //main
} // End class Sample

The sample uses the file items.xml.


<?xml version="1.0"?>
<!-- This is a sample XML document -->
<!DOCTYPE Items [<!ENTITY number "123">]>
<Items>
  <Item>Test with an entity: &number;</Item>
  <Item>test with a child element <more/> stuff</Item>
  <Item>test with a CDATA section <![CDATA[<456>]]> def</Item>
  <Item>Test with an char entity: &#65;</Item>
  <!-- Fourteen chars in this element.-->
  <Item>1234567890ABCD</Item>
</Items>

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft