FileStream.ReadAsync FileStream.ReadAsync FileStream.ReadAsync Method

Definizione

Overload

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

Legge in modo asincrono una sequenza di byte dal flusso di file corrente e li scrive in un'area di memoria, fa avanzare la posizione all'interno del flusso di file in base al numero di byte letti e monitora le richieste di annullamento.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) ReadAsync(Byte[], Int32, Int32, CancellationToken) ReadAsync(Byte[], Int32, Int32, CancellationToken)

Legge in modo asincrono una sequenza di byte dal flusso di file corrente e li scrive in una matrice di byte a partire da un offset specificato, fa avanzare la posizione all'interno del flusso di file in base al numero di byte letti e monitora le richieste di annullamento.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) ReadAsync(Memory<Byte>, CancellationToken)

Legge in modo asincrono una sequenza di byte dal flusso di file corrente e li scrive in un'area di memoria, fa avanzare la posizione all'interno del flusso di file in base al numero di byte letti e monitora le richieste di annullamento.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 = null);
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Parametri

buffer
Memory<Byte>

Buffer in cui scrivere i dati.The buffer to write the data into.

cancellationToken
CancellationToken CancellationToken CancellationToken

Token da monitorare per le richieste di annullamento.The token to monitor for cancellation requests. Il valore predefinito è None.The default value is None.

Restituisce

Attività che rappresenta l'operazione di lettura asincrona e che esegue il wrapping del numero totale di byte letti nel buffer.A task that represents the asynchronous read operation and wraps the total number of bytes read into the buffer. Il valore del risultato può essere minore del numero di byte richiesti se il numero di byte attualmente disponibili è minore di quelli richiesti o può essere pari a 0 (zero) se è stata raggiunta la fine del flusso.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.

Esempi

Nell'esempio seguente viene illustrato come leggere da un file in modo asincrono.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

Commenti

Il ReadAsync metodo consente di eseguire operazioni su file a elevato utilizzo di risorse senza bloccare il thread principale.The ReadAsync method enables you to perform resource-intensive file operations without blocking the main thread. Questa considerazione sulle prestazioni è particolarmente importante in un'applicazione Windows 8.x StoreWindows 8.x Store o desktopdesktop in cui tramite un'operazione di flusso per cui è richiesto molto tempo è possibile bloccare il thread UI e far sembrare che l'applicazione non funzioni.This performance consideration is particularly important in a Windows 8.x StoreWindows 8.x Store app or desktopdesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. I metodi asincroni vengono usati insieme async alle parole chiave e await in Visual Basic e. C#The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Utilizzare la CanRead proprietà per determinare se l'istanza corrente supporta la lettura.Use the CanRead property to determine whether the current instance supports reading.

Se l'operazione viene annullata prima del completamento, l'attività restituita TaskStatus.Canceled contiene il valore Status per la proprietà.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Status property. Se l'handle del file viene eliminato, l'attività restituita contiene l' ObjectDisposedException eccezione Task.Exception nella proprietà.If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Task.Exception property.

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

Legge in modo asincrono una sequenza di byte dal flusso di file corrente e li scrive in una matrice di byte a partire da un offset specificato, fa avanzare la posizione all'interno del flusso di file in base al numero di byte letti e monitora le richieste di annullamento.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);
[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>

Parametri

buffer
Byte[]

Buffer in cui scrivere i dati.The buffer to write the data into.

offset
Int32 Int32 Int32

Offset dei byte in buffer da cui iniziare la scrittura dei dati dal flusso.The byte offset in buffer at which to begin writing data from the stream.

count
Int32 Int32 Int32

Numero massimo di byte da leggere.The maximum number of bytes to read.

cancellationToken
CancellationToken CancellationToken CancellationToken

Token da monitorare per le richieste di annullamento.The token to monitor for cancellation requests.

Restituisce

Attività che rappresenta l'operazione di lettura asincrona e che esegue il wrapping del numero totale di byte letti nel buffer.A task that represents the asynchronous read operation and wraps the total number of bytes read into the buffer. Il valore del risultato può essere minore del numero di byte richiesti se il numero di byte attualmente disponibili è minore di quelli richiesti o può essere pari a 0 (zero) se è stata raggiunta la fine del flusso.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.

Eccezioni

offset o count è negativo.offset or count is negative.

La somma di offset e count è maggiore della lunghezza del buffer.The sum of offset and count is larger than the buffer length.

Il flusso non supporta la lettura.The stream does not support reading.

Il flusso è stato eliminato.The stream has been disposed.

Il flusso è attualmente usato da un'operazione di lettura precedente.The stream is currently in use by a previous read operation.

Esempi

Nell'esempio seguente viene illustrato come leggere da un file in modo asincrono.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

Commenti

Il ReadAsync metodo consente di eseguire operazioni su file a elevato utilizzo di risorse senza bloccare il thread principale.The ReadAsync method enables you to perform resource-intensive file operations without blocking the main thread. Questa considerazione sulle prestazioni è particolarmente importante in un'applicazione Windows 8.x StoreWindows 8.x Store o desktopdesktop in cui tramite un'operazione di flusso per cui è richiesto molto tempo è possibile bloccare il thread UI e far sembrare che l'applicazione non funzioni.This performance consideration is particularly important in a Windows 8.x StoreWindows 8.x Store app or desktopdesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. I metodi asincroni vengono usati insieme async alle parole chiave e await in Visual Basic e. C#The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Utilizzare la CanRead proprietà per determinare se l'istanza corrente supporta la lettura.Use the CanRead property to determine whether the current instance supports reading.

Se l'operazione viene annullata prima del completamento, l'attività restituita TaskStatus.Canceled contiene il valore Task.Status per la proprietà.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property. Se l'handle del file viene eliminato, l'attività restituita contiene l' ObjectDisposedException eccezione Task.Exception nella proprietà.If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Task.Exception property.

Vedi anche

Si applica a