StreamReader.ReadLineAsync Méthode

Définition

Espace de noms:

System.IO

Assembly:

System.Runtime.dll

Surcharges

ReadLineAsync()	Lit une ligne de caractères de manière asynchrone dans le flux actuel et retourne les données sous forme de chaîne.
ReadLineAsync(CancellationToken)	Lit une ligne de caractères de manière asynchrone dans le flux actuel et retourne les données sous forme de chaîne.

ReadLineAsync()

Source:

StreamReader.cs

Lit une ligne de caractères de manière asynchrone dans le flux actuel et retourne les données sous forme de chaîne.

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadLineAsync();

public override System.Threading.Tasks.Task<string?> ReadLineAsync ();

override this.ReadLineAsync : unit -> System.Threading.Tasks.Task<string>

Public Overrides Function ReadLineAsync () 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 la ligne suivante du flux, ou a la valeur null si tous les caractères ont été lus.

Exceptions

ArgumentOutOfRangeException

Le nombre de caractères dans la ligne suivante 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 la première ligne d’un fichier à l’aide de la ReadLineAsync() 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.ReadLineAsync();
                Console.WriteLine("First line 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.ReadLineAsync()
            Console.WriteLine("First line contains: " + result)
        End Using
    End Sub
End Module

Remarques

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

ReadLineAsync(CancellationToken)

Source:

StreamReader.cs

Lit une ligne de caractères de manière asynchrone dans le flux actuel et retourne les données sous forme de chaîne.

public:
 override System::Threading::Tasks::ValueTask<System::String ^> ReadLineAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.ValueTask<string?> ReadLineAsync (System.Threading.CancellationToken cancellationToken);

override this.ReadLineAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<string>

Public Overrides Function ReadLineAsync (cancellationToken As CancellationToken) As ValueTask(Of String)

Paramètres

cancellationToken

CancellationToken

Jeton pour surveiller les requêtes d'annulation.

Retours

ValueTask<String>

Valeur de tâche qui représente l'opération de lecture asynchrone. La valeur du TResult paramètre contient la ligne suivante du flux, ou est null si tous les caractères ont été lus.

Exceptions

ArgumentOutOfRangeException

Le nombre de caractères dans la ligne suivante 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 du 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 le équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception est levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour les exceptions stockées, consultez les exceptions levées par ReadLine().