XmlTextReader.ReadChars メソッドとは何？わかりやすく解説 Weblio辞書

すべての辞書から再検索する

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

索引トップ用語の索引ランキング

XmlTextReader.ReadChars メソッド

要素のテキストの内容を文字バッファに読み取ります。このメソッドは、連続して呼び出すことによって埋め込みテキストの大量のストリームを読み取るように設計されています。

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

Visual Basic (宣言)

Public Function ReadChars ( _
    buffer As Char(), _
    index As Integer, _
    count As Integer _
) As Integer

Visual Basic (使用法)

Dim instance As XmlTextReader
Dim buffer As Char()
Dim index As Integer
Dim count As Integer
Dim returnValue As Integer

returnValue = instance.ReadChars(buffer, index, count)

public int ReadChars (
    char[] buffer,
    int index,
    int count
)

C++

public:
int ReadChars (
    array<wchar_t>^ buffer, 
    int index, 
    int count
)

public int ReadChars (
    char[] buffer, 
    int index, 
    int count
)

JScript

public function ReadChars (
    buffer : char[], 
    index : int, 
    count : int
) : int

パラメータ

buffer: テキストの内容が書き込まれるバッファとして機能する文字の配列。

index: メソッドがテキストの内容の書き込みを開始できる buffer 内の位置。

count: buffer に書き込む文字数。

戻り値
読み取った文字数。リーダーが要素に配置されていない場合、または返す対象となるテキストの内容が現在のコンテキスト内にこれ以上ない場合は、0 になる可能性があります。

例外

例外の種類	条件
ArgumentException	count が buffer (バッファサイズ - index) で指定した値を超えています。
ArgumentNullException	buffer 値が null 参照 (Visual Basic では Nothing) です。
ArgumentOutOfRangeException	index < 0 または count< 0。

解説

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

XML ドキュメントに埋め込まれたテキストの大量のストリームを処理するには、これが最も効率的な方法です。ReadChars は、大きな文字列オブジェクトを割り当てるのではなく、一度に 1 つのバッファにテキストの内容を返します。このメソッドは、要素ノードだけで機能するように設計されています。他のノード型では、ReadChars は 0 を返します。

リーダーを開始タグに配置すると、ReadChars が test を返し、リーダーを終了タグの後ろに配置する XML を次に示します。

<Item>test</Item>

ReadChars には次の機能があります。

このメソッドは、要素ノードだけで機能するように設計されています。他のノード型では、ReadChars は 0 を返します。
このメソッドは、実際の文字の内容を返します。検出したエンティティ、CDATA、または他のマークアップの解決は試行されません。ReadChars は、開始タグと終了タグの間の、マークアップを含むすべての内容を返します。
ReadChars は、整形式でない XML マークアップを無視します。たとえば、次の XML 文字列 <A>1<A>2</A> を読み取ると、ReadChars は 1<A>2</A> を返します。一致する要素ペアからマークアップを返し、それ以外を無視します。
このメソッドはどのような正規化も行いません。
ReadChars は、文字ストリームの末尾に到達すると値 0 を返し、リーダーは終了タグの後ろに配置されます。
ReadChars の使用中は、属性読み取りメソッドは使用できません。

たとえば、次の XML を使用します。

 <thing>
  some text
 </thing>
 <item>
 </item>

リーダーは、while ループの末尾の <item> 要素に配置されます。

 if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name)
 {
  while(0 != reader.ReadChars(buffer, 0, 1)
  {
  // Do something.
  // Attribute values are not available at this point.
  }
 }

使用例

ReadChars を使用して XML で読み取る例を次に示します。

Visual Basic

Imports System
Imports System.Xml

' Reads an XML document using ReadChars
Public Class Sample
    Private Const filename As
 String = "items.xml"
    
    Public Shared Sub Main()
        Dim reader As XmlTextReader = Nothing
        
        Try
            ' Declare variables used by ReadChars
            Dim buffer() As Char
            Dim iCnt As Integer
 = 0
            Dim charbuffersize As Integer
            
            ' Load the reader with the data file.  Ignore white space.
            reader = New XmlTextReader(filename)
            reader.WhitespaceHandling = WhitespaceHandling.None
            
            ' Set variables used by ReadChars.
            charbuffersize = 10
            buffer = New Char(charbuffersize)
 {}
            
            ' Parse the file.  Read the element content  
            ' using the ReadChars method.
            reader.MoveToContent()
            iCnt = reader.ReadChars(buffer,0,charbuffersize)
            while (iCnt > 0)
              ' Print out chars read and the buffer contents.
              Console.WriteLine("  Chars read to buffer:"
 & iCnt)
              Console.WriteLine("  Buffer: [{0}]",
 New String(buffer, 0, iCnt))
              ' Clear the buffer.
              Array.Clear(buffer, 0, charbuffersize)
              iCnt = reader.ReadChars(buffer,0,charbuffersize)
           end while

        Finally
            If Not (reader Is
 Nothing) Then
                reader.Close()
            End If
        End Try
    End Sub 
End Class

using System;
using System.Xml;

// Reads an XML document using ReadChars

public class Sample {

  private const String filename = "items.xml";

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

    try {
          
      // Declare variables used by ReadChars
      Char []buffer;
      int iCnt = 0;
      int charbuffersize;
     
      // Load the reader with the data file.  Ignore white space.
      reader = new XmlTextReader(filename);
      reader.WhitespaceHandling = WhitespaceHandling.None;

      // Set variables used by ReadChars.
      charbuffersize = 10;
      buffer = new Char[charbuffersize];

      // Parse the file.  Read the element content
      // using the ReadChars method.
      reader.MoveToContent();
      while ( (iCnt = reader.ReadChars(buffer,0,charbuffersize))
 > 0 ) {
        // Print out chars read and the buffer contents.
        Console.WriteLine ("  Chars read to buffer:" + iCnt);
        Console.WriteLine ("  Buffer: [{0}]", new String(buffer
,0,iCnt));
        // Clear the buffer.
        Array.Clear(buffer,0,charbuffersize);
      }
       
    }
    finally {
      if (reader!=null)
        reader.Close();
    }
  }

} // End class

C++

#using <System.Xml.dll>

using namespace System;
using namespace System::Xml;

// Reads an XML document using ReadChars
int main()
{
   XmlTextReader^ reader = nullptr;
   String^ filename = "items.xml";
   try
   {
      
      // Declare variables used by ReadChars
      array<Char>^buffer;
      int iCnt = 0;
      int charbuffersize;
      
      // Load the reader with the data file.  Ignore white space.
      reader = gcnew XmlTextReader( filename );
      reader->WhitespaceHandling = WhitespaceHandling::None;
      
      // Set variables used by ReadChars.
      charbuffersize = 10;
      buffer = gcnew array<Char>(charbuffersize);
      
      // Parse the file.  Read the element content
      // using the ReadChars method.
      reader->MoveToContent();
      while ( (iCnt = reader->ReadChars( buffer, 0, charbuffersize
 )) > 0 )
      {
         
         // Print out chars read and the buffer contents.
         Console::WriteLine( "  Chars read to buffer:{0}", iCnt );
         Console::WriteLine( "  Buffer: [{0}]", gcnew String( buffer,0,iCnt
 ) );
         
         // Clear the buffer.
         Array::Clear( buffer, 0, charbuffersize );
      }
   }
   finally
   {
      if ( reader != nullptr )
            reader->Close();
   }

}

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

// Reads an XML document using ReadChars
public class Sample
{
    private static String fileName = "items.xml";

    public static void main(String[]
 args)
    {
        XmlTextReader reader = null;
        try {
            // Declare variables used by ReadChars
            char buffer[];
            int iCnt = 0;
            int charBufferSize;

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

            // Set variables used by ReadChars.
            charBufferSize = 10;
            buffer = new char[charBufferSize];

            // Parse the file.  Read the element content
            // using the ReadChars method.
            reader.MoveToContent();
            while(((iCnt = reader.ReadChars(buffer, 0,charBufferSize))
 > 0)) {
                // Print out chars read and the buffer contents.
                Console.WriteLine(("  Chars read to buffer:" + iCnt));
                Console.WriteLine("Buffer: [{0}]",
                    new String(buffer, 0, iCnt));
                // Clear the buffer.
                Array.Clear(buffer, 0, charBufferSize);
            }
        } 
        finally {
            if (reader != null) {
                reader.Close();
            }
        }
    } //main
} // End class Sample

この例では、入力として 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

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

バージョン情報

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

参照

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

このページでは「.NET Framework クラスライブラリリファレンス」からXmlTextReader.ReadChars メソッドを検索した結果を表示しています。
Weblioに収録されているすべての辞書からXmlTextReader.ReadChars メソッドを検索する場合は、下記のリンクをクリックしてください。

全ての辞書からXmlTextReader.ReadChars メソッドを検索

>> 「XmlTextReader.ReadChars メソッド」を含む用語の索引
XmlTextReader.ReadChars メソッドのページへのリンク


	© 2025 Microsoft.All rights reserved.

XmlTextReader.ReadChars メソッドとは？ わかりやすく解説

XmlTextReader.ReadChars メソッド

急上昇のことば

XmlTextReader.ReadChars メソッドとは？わかりやすく解説