DeflateStream.ReadAsync Method

Definition

Overloads

ReadAsync(Memory<Byte>, CancellationToken)

Lit de façon asynchrone une séquence d’octets dans le flux Deflate actuel, les écrit dans une plage de mémoire d’octets, avance la position dans le flux Deflate du nombre d’octets lus et supervise les demandes d’annulation.Asynchronously reads a sequence of bytes from the current Deflate stream, writes them to a byte memory range, advances the position within the Deflate stream by the number of bytes read, and monitors cancellation requests.

ReadAsync(Byte[], Int32, Int32, CancellationToken)

Lit de façon asynchrone une séquence d’octets dans le flux Deflate actuel, les écrit dans un tableau d’octets, avance la position dans le flux Deflate du nombre d’octets lus et supervise les demandes d’annulation.Asynchronously reads a sequence of bytes from the current Deflate stream, writes them to a byte array, advances the position within the Deflate stream by the number of bytes read, and monitors cancellation requests.

ReadAsync(Memory<Byte>, CancellationToken)

Lit de façon asynchrone une séquence d’octets dans le flux Deflate actuel, les écrit dans une plage de mémoire d’octets, avance la position dans le flux Deflate du nombre d’octets lus et supervise les demandes d’annulation.Asynchronously reads a sequence of bytes from the current Deflate stream, writes them to a byte memory range, advances the position within the Deflate stream by the number of bytes read, and monitors cancellation requests.

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = null) As ValueTask(Of Integer)

Parameters

buffer
Memory<Byte>

Région de la mémoire dans laquelle les données doivent être écrites.The region of memory to write the data into.

cancellationToken
CancellationToken

Jeton permettant de surveiller les demandes d'annulation.The token to monitor for cancellation requests. La valeur par défaut est None.The default value is None.

Returns

ValueTask<Int32>

Tâche qui représente l’opération de lecture asynchrone, qui wrappe le nombre total d’octets lus dans la mémoire tampon.A task that represents the asynchronous read operation, which wraps the total number of bytes read into the buffer. La valeur de résultat peut être inférieure au nombre d’octets alloués dans la mémoire tampon si ce nombre d’octets n’est pas actuellement disponible, ou égale à 0 (zéro) si la fin du flux Deflate a été atteinte.The result value can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the Deflate stream has been reached.

Remarks

La méthode ReadAsync vous permet d’effectuer des opérations d’e/s gourmandes en ressources sans bloquer le thread principal.The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Cette considération de performance est particulièrement importante dans une application Windows 8.x StoreWindows 8.x Store ou une application Bureaudesktop où une longue opération de flux peut bloquer le thread d'interface utilisateur et faire que l'application s'affiche comme si elle ne fonctionnait pas.This performance consideration is particularly important in a Windows 8.x StoreWindows 8.x Store app or Bureaudesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Les méthodes Async sont utilisées conjointement avec les mots clés async et await dans Visual Basic et C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Utilisez la propriété CanRead pour déterminer si l’instance actuelle prend en charge la lecture.Use the CanRead property to determine whether the current instance supports reading.

Si l’opération est annulée avant d’être terminée, la tâche retournée contient la valeur TaskStatus.Canceled de la propriété Task.Status.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property.

ReadAsync(Byte[], Int32, Int32, CancellationToken)

Lit de façon asynchrone une séquence d’octets dans le flux Deflate actuel, les écrit dans un tableau d’octets, avance la position dans le flux Deflate du nombre d’octets lus et supervise les demandes d’annulation.Asynchronously reads a sequence of bytes from the current Deflate stream, writes them to a byte array, advances the position within the Deflate stream by the number of bytes read, and monitors cancellation requests.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ array, int offset, int count, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] array, int offset, int count, System.Threading.CancellationToken cancellationToken);
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (array As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Parameters

array
Byte[]

Mémoire tampon où écrire les données.The buffer to write the data into.

offset
Int32

Dans le array, décalage d’octet auquel commencer l’écriture des données à partir du flux Deflate.The byte offset in array at which to begin writing data from the Deflate stream.

count
Int32

Le nombre maximum d'octets à lire.The maximum number of bytes to read.

cancellationToken
CancellationToken

Jeton permettant de surveiller les demandes d'annulation.The token to monitor for cancellation requests. La valeur par défaut est None.The default value is None.

Returns

Task<Int32>

Tâche qui représente l’opération de lecture asynchrone, qui wrappe le nombre total d’octets lus dans le array.A task that represents the asynchronous read operation, which wraps the total number of bytes read into the array. 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 égale à 0 (zéro) si la fin du flux Deflate 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 Deflate stream has been reached.

Remarks

La méthode ReadAsync vous permet d’effectuer des opérations d’e/s gourmandes en ressources sans bloquer le thread principal.The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Cette considération de performance est particulièrement importante dans une application Windows 8.x StoreWindows 8.x Store ou une application Bureaudesktop où une longue opération de flux peut bloquer le thread d'interface utilisateur et faire que l'application s'affiche comme si elle ne fonctionnait pas.This performance consideration is particularly important in a Windows 8.x StoreWindows 8.x Store app or Bureaudesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Les méthodes Async sont utilisées conjointement avec les mots clés async et await dans Visual Basic et C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Utilisez la propriété CanRead pour déterminer si l’instance actuelle prend en charge la lecture.Use the CanRead property to determine whether the current instance supports reading.

Si l’opération est annulée avant d’être terminée, la tâche retournée contient la valeur TaskStatus.Canceled de la propriété Task.Status.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property.

Applies to