StreamReader.ReadToEndAsync Méthode

Définition

Espace de noms:

System.IO

Assembly:

System.Runtime.dll

Surcharges

ReadToEndAsync()	Lit tous les caractères entre la position actuelle et la fin du flux de manière asynchrone, puis les retourne sous la forme d'une chaîne.
ReadToEndAsync(CancellationToken)	Lit tous les caractères entre la position actuelle et la fin du flux de manière asynchrone, puis les retourne sous la forme d'une chaîne.

ReadToEndAsync()

Source:

StreamReader.cs

Lit tous les caractères entre la position actuelle et la fin du flux de manière asynchrone, puis les retourne sous la forme d'une chaîne.

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)

Retours

Task<String>

Tâche qui représente l'opération de lecture asynchrone. La valeur du paramètre TResult contient une chaîne composée des caractères allant de la position actuelle à la fin du flux.

Exceptions

ArgumentOutOfRangeException

Le nombre de caractères est supérieur à Int32.MaxValue.

ObjectDisposedException

Le flux a été supprimé.

InvalidOperationException

Le lecteur est actuellement utilisé par une opération de lecture antérieure.

Exemples

L’exemple suivant montre comment lire le contenu d’un fichier à l’aide de la ReadToEndAsync() méthode .

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

Remarques

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception sera levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour connaître les exceptions stockées, consultez les exceptions levées par ReadToEnd().

ReadToEndAsync(CancellationToken)

Source:

StreamReader.cs

Lit tous les caractères entre la position actuelle et la fin du flux de manière asynchrone, puis les retourne sous la forme d'une chaîne.

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)

Paramètres

cancellationToken

CancellationToken

Jeton pour surveiller les requêtes d'annulation.

Retours

Task<String>

Tâche qui représente l'opération de lecture asynchrone. La valeur du paramètre TResult contient une chaîne composée des caractères allant de la position actuelle à la fin du flux.

Exceptions

ArgumentOutOfRangeException

Le nombre de caractères est supérieur à Int32.MaxValue.

ObjectDisposedException

Le lecteur de flux a été supprimé.

InvalidOperationException

Le lecteur est actuellement utilisé par une opération de lecture antérieure.

OperationCanceledException

Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.

Remarques

Si cette méthode est annulée via cancellationToken, certaines données qui ont été lues à partir de l’actuel Stream mais qui ne sont pas stockées (par le StreamReader) ou retournées (à l’appelant) peuvent être perdues.

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception sera levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour connaître les exceptions stockées, consultez les exceptions levées par ReadToEnd().