StringReader.ReadToEndAsync Method

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

Overloads

ReadToEndAsync()	Reads all characters from the current position to the end of the string asynchronously and returns them as a single string.
ReadToEndAsync(CancellationToken)	Reads all characters from the current position to the end of the string asynchronously and returns them as a single string.

ReadToEndAsync()

Source:

StringReader.cs

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

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync();

public override System.Threading.Tasks.Task<string> ReadToEndAsync ();

override this.ReadToEndAsync : unit -> System.Threading.Tasks.Task<string>

Public Overrides Function ReadToEndAsync () As Task(Of String)

Returns

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 string.

Exceptions

ArgumentOutOfRangeException

The number of characters is larger than Int32.MaxValue.

ObjectDisposedException

The string reader has been disposed.

InvalidOperationException

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

Examples

The following example shows how to read an entire string asynchronously.

using System;
using System.IO;
using System.Text;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            ReadCharacters();
        }

        static async void ReadCharacters()
        {
            StringBuilder stringToRead = new StringBuilder();
            stringToRead.AppendLine("Characters in 1st line to read");
            stringToRead.AppendLine("and 2nd line");
            stringToRead.AppendLine("and the end");

            using (StringReader reader = new StringReader(stringToRead.ToString()))
            {
                string readText = await reader.ReadToEndAsync();
                Console.WriteLine(readText);
            }
        }
    }
}
// The example displays the following output:
//
// Characters in 1st line to read
// and 2nd line
// and the end
//

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim stringToRead = New StringBuilder()
        stringToRead.AppendLine("Characters in 1st line to read")
        stringToRead.AppendLine("and 2nd line")
        stringToRead.AppendLine("and the end")

        Using reader As StringReader = New StringReader(stringToRead.ToString())
            Dim readText As String = Await reader.ReadToEndAsync()
            Console.WriteLine(readText)
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in 1st line to read
' and 2nd line
' and the end
'

Remarks

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by ReadToEnd().

ReadToEndAsync(CancellationToken)

Source:

StringReader.cs

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

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<string> ReadToEndAsync (System.Threading.CancellationToken cancellationToken);

override this.ReadToEndAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Overrides Function ReadToEndAsync (cancellationToken As CancellationToken) As Task(Of String)

Parameters

cancellationToken

CancellationToken

The token to monitor for cancellation requests.

Returns

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 string.

Exceptions

ArgumentOutOfRangeException

The number of characters is larger than Int32.MaxValue.

ObjectDisposedException

The string reader has been disposed.

InvalidOperationException

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

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by ReadToEnd().