XmlTextReader.ReadChars(Char[], Int32, Int32) Метод

  • Ссылка

Определение

Пространство имен:
System.Xml
Сборка:
System.Xml.ReaderWriter.dll
Сборка:
System.Xml.dll
Сборка:
netstandard.dll
Исходный код:
XmlTextReader.cs
Исходный код:
XmlTextReader.cs
Исходный код:
XmlTextReader.cs

Считывает текстовое содержимое элемента в буфер символов. Этот метод предназначен для чтения больших потоков внедренного текста путем его последовательного вызова.

public:
 int ReadChars(cli::array <char> ^ buffer, int index, int count);
public int ReadChars (char[] buffer, int index, int count);
member this.ReadChars : char[] * int * int -> int
Public Function ReadChars (buffer As Char(), index As Integer, count As Integer) As Integer

Параметры

buffer
Char[]

Массив символов, выполняющий функции буфера, в который записывается текстовое содержимое.

index
Int32

Положение в buffer, с которого метод начинает запись текстового содержимого.

count
Int32

Число символов, записываемых в buffer.

Возвращаемое значение

Int32

Число считанных символов. Если средство чтения находится не на элементе или отсутствует возвращаемый текст, это значение может быть равно 0.

Исключения

ArgumentException

count больше, чем размер, указанный в buffer (размер буфера — index).

ArgumentNullException

Значение buffer равно null.

ArgumentOutOfRangeException

index< 0 или count< 0.

Примеры

В следующем примере выполняется чтение в XML с помощью ReadChars.

#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();
   }

}

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

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

В примере в качестве входных данных используется файл 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: A</Item>
  <!-- Fourteen chars in this element.-->
  <Item>1234567890ABCD</Item>
</Items>

Комментарии

Примечание

Начиная с платформа .NET Framework 2.0 рекомендуется создавать XmlReader экземпляры с помощью XmlReader.Create метода , чтобы воспользоваться преимуществами новых функций.

Это наиболее эффективный способ обработки очень больших потоков текста, внедренного в XML-документ. Вместо выделения больших строковых объектов ReadChars возвращает текстовое содержимое в буфер за раз. Этот метод предназначен для работы только с узлами элементов. Другие типы узлов приводят ReadChars к возврату 0.

В следующем XML-коде, если средство чтения расположено в начальном теге, ReadChars возвращает и помещает test средство чтения после конечного тега.

<Item>test</Item>

ReadChars имеет следующие функциональные возможности:

  • Этот метод предназначен для работы только с узлами элементов. Другие типы узлов приводят ReadChars к возврату 0.

  • Этот метод возвращает фактическое содержимое символов. Не предпринимается никаких попыток разрешения сущностей, CDATA или любой другой разметки. ReadChars возвращает все данные между начальным и конечным тегами, включая разметку.

  • ReadChars Игнорирует разметку XML, которая не имеет правильного формата. Например, при чтении следующей XML-строки <A>1<A>2</A>ReadChars возвращает .1<A>2</A> (Он возвращает разметку из пары соответствующих элементов и игнорирует другие элементы.)

  • Этот метод не выполняет нормализацию.

  • При ReadChars достижении конца символьного потока возвращается значение 0, а средство чтения размещается после тега end.

  • Методы чтения атрибутов недоступны при использовании ReadChars.

Например, с помощью следующего XML-кода:

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

Средство чтения размещается в элементе в <item> конце цикла while.

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.
 }
}

Применяется к

См. также раздел