TextReader.ReadToEnd Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
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)
Syntax
'Declaration
Public Overridable Function ReadToEnd As String
public virtual string ReadToEnd()
Return Value
Type: System.String
A string containing all characters from the current position to the end of the TextReader.
Exceptions
| Exception | Condition |
|---|---|
| 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 |
Remarks
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.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.