XmlWriter.WriteChars Method

.NET Framework 4.5

When overridden in a derived class, writes text one buffer at a time.

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

Syntax

public abstract void WriteChars(
	char[] buffer,
	int index,
	int count
)

Parameters

buffer: Type: System.Char[]
Character array containing the text to write.

index: Type: System.Int32
The position in the buffer indicating the start of the text to write.

count: Type: System.Int32
The number of characters to write.

Exceptions

Exception	Condition
ArgumentNullException	buffer is null.
ArgumentOutOfRangeException	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.
ArgumentException	The buffer parameter value is not valid.
InvalidOperationException	An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message “An asynchronous operation is already in progress.”

Remarks

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.

For the asynchronous version of this method, see WriteCharsAsync.

Examples

			using (XmlWriter writer = XmlWriter.Create("WriteChars.xml"))
			{
				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();
			}

Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8