FileStream.ReadAsync Méthode

Définition

Surcharges

ReadAsync(Memory<Byte>, CancellationToken)

Lit de façon asynchrone une séquence d’octets dans le flux de fichier actuel, les écrit dans une zone de mémoire, avance la position dans le flux de fichier du nombre d’octets lus et supervise les demandes d’annulation.Asynchronously reads a sequence of bytes from the current file stream and writes them to a memory region, advances the position within the file 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 de fichier actuel, les écrit dans un tableau d’octets en commençant à un décalage spécifié, avance la position dans le flux de fichier du nombre d’octets lus et supervise les demandes d’annulation.Asynchronously reads a sequence of bytes from the current file stream and writes them to a byte array beginning at a specified offset, advances the position within the file 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 de fichier actuel, les écrit dans une zone de mémoire, avance la position dans le flux de fichier du nombre d’octets lus et supervise les demandes d’annulation.Asynchronously reads a sequence of bytes from the current file stream and writes them to a memory region, advances the position within the file 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 = Nothing) As ValueTask(Of Integer)

Paramètres

buffer
Memory<Byte>

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

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>

Tâche qui représente l’opération de lecture asynchrone et encapsule le nombre total d’octets lus dans la mémoire tampon.A task that represents the asynchronous read operation and wraps 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.

Exemples

L’exemple suivant montre comment lire un fichier de façon asynchrone.The following example shows how to read from a file asynchronously.

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

La ReadAsync méthode vous permet d’effectuer des opérations de fichiers gourmandes en ressources sans bloquer le thread principal.The ReadAsync method enables you to perform resource-intensive file operations without blocking the main thread. Cette considération de performance est particulièrement importante dans une application de Windows 8. x Store ou une application de bureau où une opération de flux de temps peut bloquer le thread d’interface utilisateur et faire apparaître votre application comme si elle ne fonctionnait pas.This performance consideration is particularly important in a Windows 8.x Store app or desktop 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 async await Mots clés et 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 CanRead propriété 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 TaskStatus.Canceled valeur de la Status propriété.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Status property. Si le handle du fichier est supprimé, la tâche retournée contient l' ObjectDisposedException exception dans la Task.Exception propriété.If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Task.Exception property.

S’applique à

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

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

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) 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

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

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

cancellationToken
CancellationToken

Jeton pour surveiller les requêtes d'annulation.The token to monitor for cancellation requests.

Retours

Task<Int32>

Tâche qui représente l’opération de lecture asynchrone et encapsule le nombre total d’octets lus dans la mémoire tampon.A task that represents the asynchronous read operation and wraps 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.

Attributs

Exceptions

buffer a la valeur null.buffer is null.

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 a été supprimé.The stream has been disposed.

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 un fichier de façon asynchrone.The following example shows how to read from a file asynchronously.

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

La ReadAsync méthode vous permet d’effectuer des opérations de fichiers gourmandes en ressources sans bloquer le thread principal.The ReadAsync method enables you to perform resource-intensive file operations without blocking the main thread. Cette considération de performance est particulièrement importante dans une application de Windows 8. x Store ou une application de bureau où une opération de flux de temps peut bloquer le thread d’interface utilisateur et faire apparaître votre application comme si elle ne fonctionnait pas.This performance consideration is particularly important in a Windows 8.x Store app or desktop 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 async await Mots clés et 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 CanRead propriété 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 TaskStatus.Canceled valeur de la Task.Status propriété.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property. Si le handle du fichier est supprimé, la tâche retournée contient l' ObjectDisposedException exception dans la Task.Exception propriété.If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Task.Exception property.

S’applique à