Export (0) Print
Expand All
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

TextReader.ReadToEnd Method

July 28, 2014

Reads all characters from the current position to the end of the TextReader and returns them as one string.

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.dll)

public virtual string ReadToEnd()

Return Value

Type: System.String
A string containing all characters from the current position to the end of the TextReader.

ExceptionCondition
IOException

An I/O error occurs.

ObjectDisposedException

The TextReader is closed.

OutOfMemoryException

There is insufficient memory to allocate a buffer for the returned string.

ArgumentOutOfRangeException

The number of characters in the next line is larger than MaxValue

If the current method throws an OutOfMemoryException, the reader's position in the underlying Stream is advanced by the number of characters the method was able to read, but the characters already read into the internal ReadToEnd buffer are discarded. Since the position of the reader in the stream cannot be changed, the characters already read are unrecoverable, and can be accessed only by reinitializing the TextReader. If the initial position within the stream is unknown or the stream does not support seeking, the underlying Stream also needs to be reinitialized.

To avoid such a situation and produce robust code you should use the Read method and store the read characters in a preallocated buffer.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2014 Microsoft