TextReader.ReadToEndAsync Method ()

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

[ComVisibleAttribute(false)]
[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public virtual Task<string> ReadToEndAsync()

Return Value

Type: System.Threading.Tasks.Task<String>

A task that represents the asynchronous read operation. The value of the TResult parameter contains a string with the characters from the current position to the end of the text reader.

Exception Condition
ArgumentOutOfRangeException

The number of characters is larger than MaxValue.

ObjectDisposedException

The text reader has been disposed.

InvalidOperationException

The reader is currently in use by a previous read operation.

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: