ReadChars()

XmlTextReader::ReadChars(const ArrayPtr<char16_t>&, int32_t, int32_t) method

Reads the text contents of an element into a character buffer. This method is designed to read large streams of embedded text by calling it successively.

int32_t System::Xml::XmlTextReader::ReadChars(const ArrayPtr<char16_t> &buffer, int32_t index, int32_t count)

Arguments

ParameterTypeDescription
bufferconst ArrayPtr<char16_t>&The array of characters that serves as the buffer to which the text contents are written.
indexint32_tThe position within buffer where the method can begin writing text contents.
countint32_tThe number of characters to write into buffer.

Return Value

The number of characters read. This can be 0 if the reader is not positioned on an element or if there is no more text content to return in the current context.

Exceptions

ExceptionDescription
ArgumentExceptioncount is greater than the space specified in the buffer (buffer size - index).
ArgumentNullExceptionThe buffer value is nullptr.
ArgumentOutOfRangeExceptionindex < 0 or count < 0.

See Also