TextReader.ReadBlockAsync Méthode

Définition

Surcharges

ReadBlockAsync(Memory<Char>, CancellationToken)

Lit de façon asynchrone les caractères à partir du flux actuel et écrit les données dans une mémoire tampon.Asynchronously reads the characters from the current stream and writes the data to a buffer.

ReadBlockAsync(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é.Reads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.

ReadBlockAsync(Memory<Char>, CancellationToken)

Lit de façon asynchrone les caractères à partir du flux actuel et écrit les données dans une mémoire tampon.Asynchronously reads the characters from the current stream and writes the data to a buffer.

public virtual System.Threading.Tasks.ValueTask<int> ReadBlockAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadBlockAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadBlockAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overridable Function ReadBlockAsync (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.When this method returns, contains the specified memory block of characters replaced by the characters read from the current source.

cancellationToken
CancellationToken

Jeton pour surveiller les requêtes d'annulation.The token to monitor for cancellation requests. La valeur par défaut est None.The default value is None.

Retours

ValueTask<Int32>

Valeur de tâche qui représente l'opération de lecture asynchrone.A value task that represents the asynchronous read operation. La valeur du paramètre de type contient le nombre total de caractères lus dans la mémoire tampon.The value of the type parameter contains the total number of characters read into the buffer. La valeur du résultat peut être inférieure au nombre de caractères demandés si le nombre de caractères actuellement disponibles est inférieur au nombre demandé, ou elle peut avoir la valeur 0 (zéro) si la fin du flux a été atteinte.The result value can be less than the number of characters requested if the number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

S’applique à

ReadBlockAsync(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é.Reads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadBlockAsync(cli::array <char> ^ buffer, int index, int count);
public virtual System.Threading.Tasks.Task<int> ReadBlockAsync (char[] buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task<int> ReadBlockAsync (char[] buffer, int index, int count);
abstract member ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
Public Overridable Function ReadBlockAsync (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.When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.

index
Int32

Position dans buffer à partir de laquelle commencer l'écriture.The position in buffer at which to begin writing.

count
Int32

Nombre maximal de caractères à lire.The maximum number of characters to read. 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.If the end of the text is reached before the specified number of characters is read into the buffer, the current method returns.

Retours

Task<Int32>

Tâche qui représente l'opération de lecture asynchrone.A task that represents the asynchronous read operation. La valeur du paramètre TResult contient le nombre total d'octets lus dans la mémoire tampon.The value of the TResult parameter contains the total number of bytes read into the buffer. 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.The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the text has been reached.

Attributs

Exceptions

buffer a la valeur null.buffer is null.

index ou count est un nombre négatif.index or count is negative.

La somme de index et count est supérieure à la longueur de la mémoire tampon.The sum of index and count is larger than the buffer length.

Le lecteur de texte a été supprimé.The text reader has been disposed.

Le lecteur est actuellement utilisé par une opération de lecture antérieure.The reader is currently in use by a previous read operation.

Remarques

La tâche ne se termine pas tant que le nombre de caractères spécifié par le count paramètre n’a pas été lu ou que la fin du texte n’a pas été atteinte.The task does not complete until either the number of characters specified by the count parameter are read, or the end of the text has been reached.

Voir aussi

S’applique à