StringReader.ReadToEnd Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

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

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

StringReader Class

System.IO Namespace