StringReader.ReadToEndAsync Метод

Определение

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

System.IO

Сборка:

System.Runtime.dll

Перегрузки

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

ReadToEndAsync()

Исходный код:

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

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

Примеры

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

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
'

Комментарии

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

ReadToEndAsync(CancellationToken)

Исходный код:

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

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

Комментарии

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