Edit

Share via


XmlTextWriter.WriteChars(Char[], Int32, Int32) Method

Definition

Writes text one buffer at a time.

public:
 override void WriteChars(cli::array <char> ^ buffer, int index, int count);
public override void WriteChars (char[] buffer, int index, int count);
override this.WriteChars : char[] * int * int -> unit
Public Overrides Sub WriteChars (buffer As Char(), index As Integer, count As Integer)

Parameters

buffer
Char[]

Character array containing the text to write.

index
Int32

The position in the buffer indicating the start of the text to write.

count
Int32

The number of characters to write.

Exceptions

buffer is null.

index or count is less than zero.

-or-

The buffer length minus index is less than count; the call results in surrogate pair characters being split or an invalid surrogate pair being written.

Examples

using (XmlTextWriter writer = new XmlTextWriter(Console.Out))
{
    writer.WriteStartDocument();

    char[] ch = new char[4];
    ch[0] = 't';
    ch[1] = 'e';
    ch[2] = 'x';
    ch[3] = 't';

    writer.WriteStartElement("WriteCharacters");
    writer.WriteChars(ch, 0, ch.Length);
    writer.WriteEndElement();
    writer.WriteEndDocument();
}

Remarks

Note

Starting with the .NET Framework 2.0, we recommend that you create XmlWriter instances by using the XmlWriter.Create method and the XmlWriterSettings class to take advantage of new functionality.

This method can be used to write large amounts of text one buffer at a time.

Special handling must be done to ensure the WriteChars method does not split surrogate pair characters across multiple buffer writes. The XML specification defines the valid ranges for surrogate pairs.

An exception is thrown if surrogate pair characters are written that would result in the surrogate pair characters being split in the buffer.

Applies to