StreamReader.ReadLineAsync Метод

Определение

Пространство имен:
System.IO
Сборки:
mscorlib.dll, System.IO.dll
Сборки:
netstandard.dll, System.Runtime.dll
Сборка:
System.IO.dll
Сборка:
System.Runtime.Extensions.dll
Сборка:
mscorlib.dll
Сборка:
netstandard.dll

Перегрузки

Имя Описание
ReadLineAsync()

Считывает строку символов асинхронно из текущего потока и возвращает данные в виде строки.
ReadLineAsync(CancellationToken)

Считывает строку символов асинхронно из текущего потока и возвращает данные в виде строки.

ReadLineAsync()

Исходный код:
StreamReader.cs
Исходный код:
StreamReader.cs
Исходный код:
StreamReader.cs
Исходный код:
StreamReader.cs
Исходный код:
StreamReader.cs

Считывает строку символов асинхронно из текущего потока и возвращает данные в виде строки.

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadLineAsync();
public override System.Threading.Tasks.Task<string> ReadLineAsync();
public override System.Threading.Tasks.Task<string?> ReadLineAsync();
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<string> ReadLineAsync();
override this.ReadLineAsync : unit -> System.Threading.Tasks.Task<string>
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadLineAsync : unit -> System.Threading.Tasks.Task<string>
Public Overrides Function ReadLineAsync () As Task(Of String)

Возвращаемое значение

Task<String>

Задача, представляющая асинхронную операцию чтения. Значение TResult параметра содержит следующую строку из потока или если null все символы были считаны.

Атрибуты
ComVisibleAttribute

Исключения

ArgumentOutOfRangeException

Число символов в следующей строке больше, чем Int32.MaxValue.

ObjectDisposedException

Поток удален.

InvalidOperationException

В настоящее время средство чтения используется предыдущей операцией чтения.

Примеры

В следующем примере показано, как считывать первую строку файла с помощью ReadLineAsync() метода.

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);
            }
        }
    }
}

Imports System.IO

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim result As String

        Using reader As StreamReader = File.OpenText("existingfile.txt")
            Console.WriteLine("Opened file.")
            result = Await reader.ReadLineAsync()
            Console.WriteLine("First line contains: " + result)
        End Using
    End Sub
End Module

Комментарии

Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему выбрасываются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых ReadLine().

Применяется к

ReadLineAsync(CancellationToken)

Исходный код:
StreamReader.cs
Исходный код:
StreamReader.cs
Исходный код:
StreamReader.cs
Исходный код:
StreamReader.cs
Исходный код:
StreamReader.cs

Считывает строку символов асинхронно из текущего потока и возвращает данные в виде строки.

public:
 override System::Threading::Tasks::ValueTask<System::String ^> ReadLineAsync(System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.ValueTask<string?> ReadLineAsync(System.Threading.CancellationToken cancellationToken);
override this.ReadLineAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<string>
Public Overrides Function ReadLineAsync (cancellationToken As CancellationToken) As ValueTask(Of String)

Параметры

cancellationToken
CancellationToken

Маркер для отслеживания запросов на отмену.

Возвращаемое значение

ValueTask<String>

Задача значения, представляющая асинхронную операцию чтения. Значение TResult параметра содержит следующую строку из потока или если null все символы были прочитаны.

Исключения

ArgumentOutOfRangeException

Число символов в следующей строке больше, чем Int32.MaxValue.

ObjectDisposedException

Средство чтения потоков удалено.

InvalidOperationException

В настоящее время средство чтения используется предыдущей операцией чтения.

OperationCanceledException

Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.

Комментарии

Если этот метод отменен с помощью cancellationToken, некоторые данные, считываемые из текущего Stream , но не хранящегося ( StreamReaderвызывающего) или возвращаемого (вызывающему объекту), могут быть потеряны.

Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему выбрасываются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых ReadLine().

Применяется к