StringReader.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 de la chaîne de manière asynchrone, puis les retourne sous la forme d’une chaîne unique.
ReadToEndAsync(CancellationToken)	Lit tous les caractères entre la position actuelle et la fin de la chaîne de manière asynchrone, puis les retourne sous la forme d’une chaîne unique.

ReadToEndAsync()

Source:

StringReader.cs

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

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 de la position actuelle jusqu’à la fin de la chaîne.

Exceptions

ArgumentOutOfRangeException

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

ObjectDisposedException

Le lecteur de chaîne a été supprimé.

InvalidOperationException

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

Exemples

L’exemple suivant montre comment lire une chaîne entière de façon asynchrone.

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
'

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 ReadToEnd().

ReadToEndAsync(CancellationToken)

Source:

StringReader.cs

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

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 de la position actuelle jusqu’à la fin de la chaîne.

Exceptions

ArgumentOutOfRangeException

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

ObjectDisposedException

Le lecteur de chaîne 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

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 ReadToEnd().