TextReader.ReadAsync Méthode

Définition

Surcharges

Nom Description
ReadAsync(Char[], Int32, Int32)

Lit de façon asynchrone un nombre maximal spécifié de caractères à partir du 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)

Lit de manière 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 spécifié de caractères à partir du 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);
[System.Runtime.InteropServices.ComVisible(false)]
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>
[<System.Runtime.InteropServices.ComVisible(false)>]
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[]

Lorsque cette méthode retourne, contient le tableau de caractères spécifié avec les valeurs comprises entre index et (index + count - 1) remplacées par les caractères lus à partir de la source actuelle.

index
Int32

Position dans buffer laquelle commencer l’écriture.

count
Int32

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

Retours

Tâche qui représente l’opération de lecture asynchrone. La valeur du TResult paramètre 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é si le nombre d’octets actuellement disponibles est inférieur au nombre demandé, ou il peut être égal à 0 (zéro) si la fin du texte a été atteinte.

Attributs

Exceptions

buffer a la valeur null.

index ou count est négatif.

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

Le lecteur de texte a été supprimé.

Le lecteur est actuellement utilisé par une opération de lecture précédente.

Remarques

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

La TextReader classe 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 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 est levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de façon synchrone. Pour les exceptions stockées, consultez les exceptions levées par Read(Char[], Int32, Int32).

Voir aussi

S’applique à

ReadAsync(Memory<Char>, CancellationToken)

Lit de manière 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>

Lorsque cette méthode est retournée, contient le bloc de mémoire spécifié de caractères remplacé par les caractères lus à partir de la source actuelle.

cancellationToken
CancellationToken

Jeton à surveiller pour les demandes d’annulation. La valeur par défaut est None.

Retours

Tâche de valeur 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 à la fin du flux et qu’aucune donnée n’a été lue. Le nombre est inférieur ou égal à la buffer longueur, selon que les données sont disponibles dans le flux.

Exceptions

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

S’applique à