Share via


ReadToEnd Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

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

Syntax

'Declaration
Public Overridable Function ReadToEnd As String
public virtual string ReadToEnd()
public:
virtual String^ ReadToEnd()
abstract ReadToEnd : unit -> string 
override ReadToEnd : unit -> string 
public function ReadToEnd() : String

Return Value

Type: System. . :: . .String
A string that contains all characters from the current position to the end of the text reader.

Remarks

If the method throws an OutOfMemoryException exception, the reader's position in the underlying Stream is advanced by the number of characters the method was able to read, but the characters that were already read into the internal ReadToEnd buffer are discarded. Because the position of the reader in the stream cannot be changed, the characters that were 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.

.NET Framework Security

See Also

Reference

TextReader Class

System.IO Namespace