StreamReader.ReadToEndAsync Метод

Определение

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

Перегрузки

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

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

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

ReadToEndAsync()

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

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

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

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

Task<String>

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

Атрибуты
ComVisibleAttribute

Исключения

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)

Исходный код:
StreamReader.cs
Исходный код:
StreamReader.cs
Исходный код:
StreamReader.cs
Исходный код:
StreamReader.cs
Исходный код:
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().

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