Stream.ReadAsync Stream.ReadAsync Stream.ReadAsync Stream.ReadAsync Method

Définition

Lit de façon asynchrone une séquence d'octets dans le flux actuel et avance la position dans le flux du nombre d'octets lus.Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Surcharges

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

Lit de façon asynchrone une séquence d'octets dans le flux actuel, avance la position dans le flux du nombre d'octets lus et surveille les demandes d'annulation.Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

ReadAsync(Memory<Byte>, CancellationToken) ReadAsync(Memory<Byte>, CancellationToken)

Lit de façon asynchrone une séquence d'octets dans le flux actuel, avance la position dans le flux du nombre d'octets lus et surveille les demandes d'annulation.Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

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

Lit de façon asynchrone une séquence d'octets dans le flux actuel et avance la position dans le flux du nombre d'octets lus.Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

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

Lit de façon asynchrone une séquence d'octets dans le flux actuel, avance la position dans le flux du nombre d'octets lus et surveille les demandes d'annulation.Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
abstract member ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Paramètres

buffer
Byte[]

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

offset
Int32 Int32 Int32 Int32

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

count
Int32 Int32 Int32 Int32

Nombre maximal d'octets à lire.The maximum number of bytes to read.

cancellationToken
CancellationToken CancellationToken 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

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 du 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 flux 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 stream has been reached.

Exceptions

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

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

Le flux ne prend pas en charge la lecture.The stream does not support reading.

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

Remarques

Le ReadAsync méthode 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 asynchrones sont utilisées conjointement avec la async et await mots clés dans Visual Basic et c#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Utilisez le CanRead propriété afin de 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 la fin, la tâche retournée contient le Canceled valeur pour le Status propriété.If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

Pour obtenir un exemple, consultez le ReadAsync(Byte[], Int32, Int32) de surcharge.For an example, see the ReadAsync(Byte[], Int32, Int32) overload.

Voir aussi

ReadAsync(Memory<Byte>, CancellationToken) ReadAsync(Memory<Byte>, CancellationToken)

Lit de façon asynchrone une séquence d'octets dans le flux actuel, avance la position dans le flux du nombre d'octets lus et surveille les demandes d'annulation.Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

public virtual System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = null);
abstract member ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Paramètres

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 CancellationToken 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

Tâche qui représente l'opération de lecture asynchrone.A task that represents the asynchronous read operation. La valeur de sa propriété Result contient le nombre total d’octets lus dans la mémoire tampon.The value of its Result property contains 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 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 stream has been reached.

Remarques

Le ReadAsync méthode 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 asynchrones sont utilisées conjointement avec la async et await mots clés dans Visual Basic et c#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Utilisez le CanRead propriété afin de 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 la fin, la tâche retournée contient le TaskStatus.Canceled valeur pour le Status propriété.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Status property.

Pour obtenir un exemple, consultez le ReadAsync(Byte[], Int32, Int32) de surcharge.For an example, see the ReadAsync(Byte[], Int32, Int32) overload.

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

Lit de façon asynchrone une séquence d'octets dans le flux actuel et avance la position dans le flux du nombre d'octets lus.Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

public:
 System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count);
member this.ReadAsync : byte[] * int * int -> System.Threading.Tasks.Task<int>
Public Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer) As Task(Of Integer)

Paramètres

buffer
Byte[]

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

offset
Int32 Int32 Int32 Int32

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

count
Int32 Int32 Int32 Int32

Nombre maximal d'octets à lire.The maximum number of bytes to read.

Retours

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 du 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 flux 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 stream has been reached.

Exceptions

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

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

Le flux ne prend pas en charge la lecture.The stream does not support reading.

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

Exemples

L’exemple suivant montre comment lire à partir d’un fichier de façon asynchrone.The following example shows how to read from a file asynchronously. L’exemple utilise le FileStream classe qui dérive de la Stream classe.The example uses the FileStream class, which derives from the Stream class.

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string filename = @"c:\Temp\userinputlog.txt";
            byte[] result;

            using (FileStream SourceStream = File.Open(filename, FileMode.Open))
            {
                result = new byte[SourceStream.Length];
                await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
            }

            UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
        }
    }
}
Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

Remarques

Le ReadAsync méthode 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 asynchrones sont utilisées conjointement avec la async et await mots clés dans Visual Basic et c#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

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

S’applique à