XmlTextReader.GetRemainder メソッド

.NET Framework クラス ライブラリ リファレンス

XmlTextReader.GetRemainder メソッド

バッファ内の XML の剰余を取得します。

名前空間: System.Xml
アセンブリ: System.Xml (system.xml.dll 内)
構文

Visual Basic (宣言)

Public Function GetRemainder As
 TextReader

Visual Basic (使用法)

Dim instance As XmlTextReader
Dim returnValue As TextReader

returnValue = instance.GetRemainder

C#

public TextReader GetRemainder ()

C++

public:
TextReader^ GetRemainder ()

J#

public TextReader GetRemainder ()

JScript

public function GetRemainder () : TextReader

戻り値
バッファ内の XML の剰余を格納している TextReader。

解説

メモ
Microsoft .NET Framework version 2.0 リリースでは、System.Xml.XmlReader.Create メソッドを使用して XmlReader インスタンスを作成することをお勧めします。これにより、このリリースで導入された新機能を十分に活用できます。詳細については、「XML リーダーの作成」を参照してください。

XmlTextReader はバッファ内の読み取りを実行するため、データが消失しないように、未使用のバッファの剰余を返すことができる必要があります。これにより、プロトコル (マルチパート MIME など) で XML を他のものと同じストリームにパッケージ化できます。

このメソッドを呼び出すと、EOF は true に設定されます。

使用例

XML ドキュメントの最初の部分を読み取り、次に GetRemainder を使用して、2 番目のリーダーを使用したドキュメントの読み取りを完了する例を次に示します。

Visual Basic

Imports System
Imports System.Xml

Public Class Sample
    Private Shared filename As
 String = "tworeads.xml"
    
    Public Shared Sub Main()

        Dim reader As New
 XmlTextReader(filename)
        reader.WhitespaceHandling = WhitespaceHandling.None
        
        ' Read the first part of the XML document
        While reader.Read()
            ' Display the elements and stop reading on the book endelement
 tag
            ' then go to ReadPart2 to start another reader to read the
 rest of the file. 
            Select Case reader.NodeType
                Case XmlNodeType.Element
                    Console.WriteLine("Name: {0}",
 reader.Name)
                Case XmlNodeType.Text
                    Console.WriteLine("  Element Text: {0}",
 reader.Value)
                Case XmlNodeType.EndElement
                    ' Stop reading when the reader gets to the end element
 of the book node.
                    If "book" =
 reader.LocalName Then
                        Console.WriteLine("End reading first book...")
                        Console.WriteLine()
                        GoTo ReadPart2
                    End If
            End Select
        End While
        
        ' Read the rest of the XML document
        ReadPart2: 
        Console.WriteLine("Begin reading second book...")
        
        ' Create a new reader to read the rest of the document.
        Dim reader2 As New
 XmlTextReader(reader.GetRemainder())
        
        While reader2.Read()
            Select Case reader2.NodeType
                Case XmlNodeType.Element
                    Console.WriteLine("Name: {0}",
 reader2.Name)
                Case XmlNodeType.Text
                    Console.WriteLine("  Element Text: {0}",
 reader2.Value)
                Case XmlNodeType.EndElement
                    'Stop reading when the reader gets to the end element
 of the book node.
                    If "book" =
 reader2.LocalName Then
                        Console.WriteLine("End reading second
 book...")
                        GoTo Done
                    End If
            End Select
        End While
        
        Done: 
        Console.WriteLine("Done.")
        reader.Close()
        reader2.Close()
    End Sub 'Main
End Class 'Sample

C#

using System;
using System.Xml; 

public class Sample {

  private static string
 filename = "tworeads.xml";
   
  public static void Main()
 {
  
    XmlTextReader reader = new XmlTextReader(filename);
    reader.WhitespaceHandling=WhitespaceHandling.None;

    // Read the first part of the XML document
    while(reader.Read()) {
      // Display the elements and stop reading on the book endelement
 tag
      // then go to ReadPart2 to start another reader to read the rest
 of the file. 
      switch(reader.NodeType) {
       case XmlNodeType.Element:
        Console.WriteLine("Name: {0}", reader.Name);
        break;
       case XmlNodeType.Text:
        Console.WriteLine("  Element Text: {0}", reader.Value);
        break;
       case XmlNodeType.EndElement:
        // Stop reading when the reader gets to the end element of the
 book node.
        if ("book"==reader.LocalName) {
          Console.WriteLine("End reading first book...");
          Console.WriteLine();      
          goto ReadPart2;
        }
        break;
      } 
    } 

    // Read the rest of the XML document
    ReadPart2:
    Console.WriteLine("Begin reading second book...");

    // Create a new reader to read the rest of the document.
    XmlTextReader reader2 = new XmlTextReader(reader.GetRemainder());

    while(reader2.Read()) {
      switch (reader2.NodeType) {
        case XmlNodeType.Element:
         Console.WriteLine("Name: {0}", reader2.Name);
         break;
        case XmlNodeType.Text:
         Console.WriteLine("  Element Text: {0}", reader2.Value);
         break;
        case XmlNodeType.EndElement:
         // Stop reading when the reader gets to the end element of the
 book node.
         if ("book"==reader2.LocalName) {
           Console.WriteLine("End reading second book...");
           goto Done;
         }
         break;
      }
    }

    Done:
    Console.WriteLine("Done.");
    reader.Close(); 
    reader2.Close();
  }
}//End class

C++

#using <System.Xml.dll>

using namespace System;
using namespace System::Xml;
int main()
{
   String^ filename = "tworeads.xml";
   XmlTextReader^ reader = gcnew XmlTextReader( filename );
   reader->WhitespaceHandling = WhitespaceHandling::None;
   
   // Read the first part of the XML document
   while ( reader->Read() )
   {
      
      // Display the elements and stop reading on the book endelement
 tag
      // then go to ReadPart2 to start another reader to read the rest
 of the file. 
      switch ( reader->NodeType )
      {
         case XmlNodeType::Element:
            Console::WriteLine( "Name: {0}", reader->Name );
            break;

         case XmlNodeType::Text:
            Console::WriteLine( "  Element Text: {0}", reader->Value
 );
            break;

         case XmlNodeType::EndElement:
            
            // Stop reading when the reader gets to the end element of the
 book node.
            if ( "book" == reader->LocalName )
            {
               Console::WriteLine( "End reading first book..." );
               Console::WriteLine();
               goto ReadPart2;
            }
            break;
      }
   }

   
   // Read the rest of the XML document
   
ReadPart2:
   Console::WriteLine( "Begin reading second book..." );
   
   // Create a new reader to read the rest of the document.
   XmlTextReader^ reader2 = gcnew XmlTextReader( reader->GetRemainder() );
   while ( reader2->Read() )
   {
      switch ( reader2->NodeType )
      {
         case XmlNodeType::Element:
            Console::WriteLine( "Name: {0}", reader2->Name );
            break;

         case XmlNodeType::Text:
            Console::WriteLine( "  Element Text: {0}", reader2->Value
 );
            break;

         case XmlNodeType::EndElement:
            
            // Stop reading when the reader gets to the end element of the
 book node.
            if ( "book" == reader2->LocalName )
            {
               Console::WriteLine( "End reading second book..." );
               goto Done;
            }
            break;
      }
   }

   
Done:
   Console::WriteLine( "Done." );
   reader->Close();
   reader2->Close();
}

J#

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

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

    public static void main(String[]
 args)
    {
        XmlTextReader reader = new XmlTextReader(fileName);
        reader.set_WhitespaceHandling(WhitespaceHandling.None);

        // Read the first part of the XML document
        while (reader.Read()) {

            // Display the elements and stop reading on the book endelement
 tag
            // then go to ReadPart2 to start another reader to read
 the rest
            // of the file. 
            switch (reader.get_NodeType()) {
                case XmlNodeType.Element :
                    Console.WriteLine("Name: {0}", reader.get_Name());
                    break;
                case XmlNodeType.Text :
                    Console.WriteLine("  Element Text: {0}", reader.get_Value());
                    break;
                case XmlNodeType.EndElement :

                    // Stop reading when the reader gets to the end
 element 
                    //of the book node.
                    if ("book".Equals(reader.get_LocalName()))
 {
                        Console.WriteLine("End reading first book...");
                        Console.WriteLine();
                    }
                    break;
            }
        }

        // Read the rest of the XML document
        // Create a new reader to read the rest of the document.
        XmlTextReader reader2 = new XmlTextReader(reader.GetRemainder());
        while (reader2.Read()) {
            switch (reader2.get_NodeType()) {
                case XmlNodeType.Element :
                    Console.WriteLine("Name: {0}", reader2.get_Name());
                    break;
                case XmlNodeType.Text :
                    Console.WriteLine
                        ("  Element Text: {0}", reader2.get_Value());
                    break;
                case XmlNodeType.EndElement :
                    // Stop reading when the reader gets to the end
 element
                    // of the book node.
                    if ("book".Equals(reader2.get_LocalName()))
 {
                        Console.WriteLine("End reading second book...");
                    }
                    break;
            }
        }
        reader.Close();
        reader2.Close();
    } //main
}//End class Sample

この例では、tworeads.xml という入力ファイルを使用しています。

<?xml version="1.0" ?>
<bookstore>
 <book>
  <title>Pride And
 Prejudice</title>
  <author>Jane Austen</author>
 </book>
 <book>
  <title>The Handmaid's
 Tale</title>
  <author>Margaret
 Atwood</author>
 </book>
</bookstore>

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
XmlTextReader クラス
XmlTextReader メンバ
System.Xml 名前空間
その他の技術情報
XmlReader による XML の読み取り