Export (0) Print
Expand All

StringReader.ReadToEnd Method

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)

public override string ReadToEnd ()
public String ReadToEnd ()
public override function ReadToEnd () : String

Return Value

The content from the current position to the end of the underlying string.

Exception typeCondition

OutOfMemoryException

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

ObjectDisposedException

The current reader is closed.

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.

The following table lists examples of other typical or related I/O tasks.

To do this...

See the example in this topic...

Create a text file.

How to: Write Text to a File

Write to a text file.

How to: Write Text to a File

Read from a text file.

How to: Read Text from a File

Append text to a file.

How to: Open and Append to a Log File

File.AppendText

FileInfo.AppendText

Get the size of a file.

FileInfo.Length

Get the attributes of a file.

File.GetAttributes

Set the attributes of a file.

File.SetAttributes

Determine if a file exists.

File.Exists

Read from a binary file.

How to: Read and Write to a Newly Created Data File

Write to a binary file.

How to: Read and Write to a Newly Created Data File

This code example is part of a larger example provided for the TextReader class.

static void ReadText(TextReader textReader)
{
    Console.WriteLine("From {0} - {1}", 
        textReader.GetType().Name, textReader.ReadToEnd());
}

static void ReadText(TextReader textReader) 
{
    Console.WriteLine("From {0} - {1}", 
        textReader.GetType().get_Name(),textReader.ReadToEnd());
} //ReadText

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2015 Microsoft