StreamReader.ReadToEndAsync Metoda

Definicja

Przestrzeń nazw:

System.IO

Zestaw:

System.Runtime.dll

Przeciążenia

ReadToEndAsync()	Odczytuje wszystkie znaki z bieżącego położenia na końcu strumienia asynchronicznie i zwraca je jako jeden ciąg.
ReadToEndAsync(CancellationToken)	Odczytuje wszystkie znaki z bieżącego położenia na końcu strumienia asynchronicznie i zwraca je jako jeden ciąg.

ReadToEndAsync()

Źródło:

StreamReader.cs

Odczytuje wszystkie znaki z bieżącego położenia na końcu strumienia asynchronicznie i zwraca je jako jeden ciąg.

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)

Zwraca

Task<String>

Zadanie reprezentujące asynchroniczną operację odczytu. Wartość parametru TResult zawiera ciąg z znakami z bieżącej pozycji na końcu strumienia.

Wyjątki

ArgumentOutOfRangeException

Liczba znaków jest większa niż Int32.MaxValue.

ObjectDisposedException

Strumień został usunięty.

InvalidOperationException

Czytnik jest obecnie używany przez poprzednią operację odczytu.

Przykłady

W poniższym przykładzie pokazano, jak odczytać zawartość pliku przy użyciu ReadToEndAsync() metody .

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

Uwagi

Ta metoda jest przechowywana w zadaniu, które zwraca wszystkie wyjątki nieużytowe, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwracanym zadaniu, ten wyjątek zostanie zgłoszony podczas oczekiwania zadania. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłoszone przez ReadToEnd()usługę .

ReadToEndAsync(CancellationToken)

Źródło:

StreamReader.cs

Odczytuje wszystkie znaki z bieżącego położenia na końcu strumienia asynchronicznie i zwraca je jako jeden ciąg.

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)

Parametry

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania.

Zwraca

Task<String>

Zadanie reprezentujące asynchroniczną operację odczytu. Wartość parametru TResult zawiera ciąg z znakami z bieżącej pozycji na końcu strumienia.

Wyjątki

ArgumentOutOfRangeException

Liczba znaków jest większa niż Int32.MaxValue.

ObjectDisposedException

Czytnik strumienia został usunięty.

InvalidOperationException

Czytnik jest obecnie używany przez poprzednią operację odczytu.

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

Jeśli ta metoda zostanie anulowana za pośrednictwem cancellationTokenmetody , niektóre dane, które zostały odczytane z bieżącej Stream , ale nie są przechowywane (przez StreamReaderelement ) lub zwracane (do obiektu wywołującego) mogą zostać utracone.

Ta metoda jest przechowywana w zadaniu, które zwraca wszystkie wyjątki nieużytowe, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwracanym zadaniu, ten wyjątek zostanie zgłoszony podczas oczekiwania zadania. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłoszone przez ReadToEnd()usługę .