TextReader.ReadAsync Méthode

Définition

Espace de noms:

System.IO

Assembly:

System.Runtime.dll

Surcharges

ReadAsync(Memory<Char>, CancellationToken)	Lit de façon asynchrone les caractères du flux actuel dans un bloc de mémoire.
ReadAsync(Char[], Int32, Int32)	Lit de façon asynchrone un nombre maximal de caractères spécifié dans le lecteur de texte actuel et écrit les données dans une mémoire tampon, en commençant à l'index spécifié.

ReadAsync(Memory<Char>, CancellationToken)

Source:

TextReader.cs

Lit de façon asynchrone les caractères du flux actuel dans un bloc de mémoire.

public virtual System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overridable Function ReadAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Paramètres

buffer

Memory<Char>

Quand cette méthode retourne un résultat, contient le bloc mémoire spécifié de caractères remplacés par les caractères lus dans la source actuelle.

cancellationToken

CancellationToken

Jeton pour surveiller les requêtes d'annulation. La valeur par défaut est None.

Retours

ValueTask<Int32>

Valeur de tâche qui représente l'opération de lecture asynchrone. La valeur du paramètre de type contient le nombre de caractères qui ont été lus, ou 0 si c'est la fin du flux et qu'aucune donnée n'a été lue. Le nombre sera inférieur ou égal à la longueur buffer, selon que les données sont, ou non, disponibles dans le flux.

Exceptions

OperationCanceledException

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

ReadAsync(Char[], Int32, Int32)

Source:

TextReader.cs

Lit de façon asynchrone un nombre maximal de caractères spécifié dans le lecteur de texte actuel et écrit les données dans une mémoire tampon, en commençant à l'index spécifié.

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);

public virtual System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);

abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>

Public Overridable Function ReadAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

Paramètres

buffer

Char[]

Quand cette méthode est retournée, contient le tableau de caractères spécifié dont les valeurs comprises entre index et (index + count - 1) sont remplacées par les caractères lus dans la source actuelle.

index

Int32

Position dans buffer à partir de laquelle commencer l'écriture.

count

Int32

Nombre maximal de caractères à lire. Si la fin du texte est atteinte avant que le nombre de caractères spécifié soit lu dans la mémoire tampon, la méthode en cours est retournée.

Retours

Task<Int32>

Tâche qui représente l'opération de lecture asynchrone. La valeur du paramètre TResult contient le nombre total d'octets lus dans la mémoire tampon. La valeur de résultat peut être inférieure au nombre d'octets demandés si le nombre d'octets actuellement disponibles est inférieur au nombre demandé, ou elle peut avoir la valeur 0 (zéro) si la fin du texte a été atteinte.

Exceptions

ArgumentNullException

buffer a la valeur null.

ArgumentOutOfRangeException

index ou count est un nombre négatif.

ArgumentException

La somme de index et count est supérieure à la longueur de la mémoire tampon.

ObjectDisposedException

Le lecteur de texte a été supprimé.

InvalidOperationException

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

Remarques

La tâche se termine une fois que le nombre de caractères spécifié par le count paramètre a été lu ou que la fin du fichier est atteinte.

La classe TextReader est une classe abstraite. Par conséquent, vous ne l’instanciez pas dans votre code. Pour obtenir un exemple d’utilisation de la ReadAsync méthode , consultez la StreamReader.ReadAsync méthode .

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 Read(Char[], Int32, Int32).

Voir aussi

• ReadAsync(Char[], Int32, Int32)
• ReadAsync(Char[], Int32, Int32)
• Fichier et flux de données E/S
• Procédure : lire le texte d’un fichier
• Procédure : écrire du texte dans un fichier