TextReader.ReadToEnd TextReader.ReadToEnd TextReader.ReadToEnd TextReader.ReadToEnd Method

Definition

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

public:
 virtual System::String ^ ReadToEnd();
public virtual string ReadToEnd ();
abstract member ReadToEnd : unit -> string
override this.ReadToEnd : unit -> string
Public Overridable Function ReadToEnd () As String

Returns

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

Exceptions

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

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.

The TextReader class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the ReadToEnd method, see the StreamReader.ReadToEnd method.

Applies to

See also