StreamReader.ReadLineAsync Method

Definition

Namespace:

System.IO

Assemblies:

netstandard.dll, System.Runtime.dll

Overloads

ReadLineAsync()	Reads a line of characters asynchronously from the current stream and returns the data as a string.
ReadLineAsync(CancellationToken)	Reads a line of characters asynchronously from the current stream and returns the data as a string.

ReadLineAsync()

Source:

StreamReader.cs

Reads a line of characters asynchronously from the current stream and returns the data as a string.

C#

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

Returns

Task<String>

A task that represents the asynchronous read operation. The value of the TResult parameter contains the next line from the stream, or is null if all the characters have been read.

Exceptions

ArgumentOutOfRangeException

The number of characters in the next line is larger than Int32.MaxValue.

ObjectDisposedException

The stream has been disposed.

InvalidOperationException

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

Examples

The following example shows how to read the first line of a file by using the ReadLineAsync() method.

C#

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static async Task Main()
        {
            await ReadCharacters();
        }

        static async Task ReadCharacters()
        {
            String result;
            using (StreamReader reader = File.OpenText("existingfile.txt"))
            {
                Console.WriteLine("Opened file.");
                result = await reader.ReadLineAsync();
                Console.WriteLine("First line contains: " + result);
            }
        }
    }
}

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 ReadLine().

ReadLineAsync(CancellationToken)

Source:

StreamReader.cs

Reads a line of characters asynchronously from the current stream and returns the data as a string.

C#

public override System.Threading.Tasks.ValueTask<string?> ReadLineAsync(System.Threading.CancellationToken cancellationToken);

Parameters

cancellationToken

CancellationToken

The token to monitor for cancellation requests.

Returns

ValueTask<String>

A value task that represents the asynchronous read operation. The value of the TResult parameter contains the next line from the stream, or is null if all of the characters have been read.

Exceptions

ArgumentOutOfRangeException

The number of characters in the next line is larger than Int32.MaxValue.

ObjectDisposedException

The stream 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

If this method is canceled via cancellationToken, some data that has been read from the current Stream but not stored (by the StreamReader) or returned (to the caller) may be lost.

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 ReadLine().