StringReader.ReadToEnd Method

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

Source:

StringReader.cs

Reads all characters from the current position to the end of the string and returns them as a single string.

public:
 override System::String ^ ReadToEnd();

public override string ReadToEnd ();

override this.ReadToEnd : unit -> string

Public Overrides Function ReadToEnd () As String

Returns

String

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

Exceptions

OutOfMemoryException

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

ObjectDisposedException

The current reader is closed.

Examples

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

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().Name, textReader.ReadToEnd());
}

Shared Sub ReadText(aTextReader As TextReader)
    Console.WriteLine("From {0} - {1}", _
        aTextReader.GetType().Name, aTextReader.ReadToEnd())
End Sub

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, but the characters already read into the internal ReadToEnd buffer are discarded. Because 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, 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

See also

• File and Stream I/O
• How to: Read Text from a File
• How to: Write Text to a File