StreamReader.ReadToEndAsync Метод

Определение

Пространство имен:

System.IO

Сборка:

System.Runtime.dll

Перегрузки

ReadToEndAsync()	Асинхронно считывает все символы, начиная с текущей позиции до конца потока, и возвращает их в виде одной строки.
ReadToEndAsync(CancellationToken)	Асинхронно считывает все символы, начиная с текущей позиции до конца потока, и возвращает их в виде одной строки.

ReadToEndAsync()

Source:

StreamReader.cs

Асинхронно считывает все символы, начиная с текущей позиции до конца потока, и возвращает их в виде одной строки.

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)

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

Task<String>

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

Исключения

ArgumentOutOfRangeException

Число символов больше, чем Int32.MaxValue.

ObjectDisposedException

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

InvalidOperationException

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

Примеры

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

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.ReadToEndAsync();
                Console.WriteLine("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.ReadToEndAsync()
            Console.WriteLine("Contains: " + result)
        End Using
    End Sub
End Module

Комментарии

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

ReadToEndAsync(CancellationToken)

Source:

StreamReader.cs

Асинхронно считывает все символы, начиная с текущей позиции до конца потока, и возвращает их в виде одной строки.

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)

Параметры

cancellationToken

CancellationToken

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

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

Task<String>

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

Исключения

ArgumentOutOfRangeException

Число символов больше, чем Int32.MaxValue.

ObjectDisposedException

Модуль чтения потока удален.

InvalidOperationException

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

OperationCanceledException

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

Комментарии

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

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