StringReader.ReadToEnd Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Reads the stream as a string, either in its entirety or from the current position to the end of the stream.
Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Overrides Function ReadToEnd As String
public override string ReadToEnd()
Return Value
Type: System.String
The content from the current position to the end of the underlying string.
Exceptions
| Exception | Condition |
|---|---|
| OutOfMemoryException | There is insufficient memory to allocate a buffer for the returned string. |
| ObjectDisposedException | The current reader is closed. |
Remarks
This method overrides the TextReader.ReadToEnd method.
If the current method throws an OutOfMemoryException, the reader's position in the underlying string is advanced by the number of characters the method was able to read, and the characters already read into the internal ReadToEnd buffer are discarded. Since the position of the reader in the string cannot be changed, the characters already read are unrecoverable, and can be accessed only by reinitializing the StringReader. 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.