FileStream.ReadAsync Metoda

Definicja

Przeciążenia

ReadAsync(Memory<Byte>, CancellationToken)

Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia plików i zapisuje je w regionie pamięci, przesuwa pozycję w strumieniu pliku o liczbę odczytanych bajtów i monitoruje żądania anulowania.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)

Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia plików i zapisuje je w tablicy bajtów Zaczynając od określonego przesunięcia, przesuwa pozycję w strumieniu pliku o liczbę odczytanych bajtów i monitoruje żądania anulowania.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)

Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia plików i zapisuje je w regionie pamięci, przesuwa pozycję w strumieniu pliku o liczbę odczytanych bajtów i monitoruje żądania anulowania.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)

Parametry

buffer
Memory<Byte>

Bufor, w którym mają zostać zapisane dane.The buffer to write the data into.

cancellationToken
CancellationToken

Token do monitorowania żądań anulowania.The token to monitor for cancellation requests. Wartość domyślna to None.The default value is None.

Zwraca

ValueTask<Int32>

Zadanie, które reprezentuje asynchroniczną operację odczytu i otacza całkowitą liczbę bajtów odczytywanych w buforze.A task that represents the asynchronous read operation and wraps the total number of bytes read into the buffer. Wartość wynikowa może być mniejsza niż liczba żądanych bajtów, jeśli liczba aktualnie dostępnych bajtów jest mniejsza niż żądana liczba, lub może być równa 0 (zero), jeśli osiągnięto koniec strumienia.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.

Przykłady

Poniższy przykład pokazuje, jak odczytywać asynchronicznie z pliku.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

Uwagi

ReadAsyncMetoda ta umożliwia wykonywanie operacji na plikach intensywnie korzystających z zasobów bez blokowania wątku głównego.The ReadAsync method enables you to perform resource-intensive file operations without blocking the main thread. Ten wpływ na wydajność jest szczególnie istotny w aplikacji do sklepu Windows 8. x lub aplikacji klasycznej, w której czasochłonna operacja przesyłania strumieniowego może blokować wątek interfejsu użytkownika i sprawiać, że aplikacja wygląda tak, jakby nie działała.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. Metody asynchroniczne są używane w połączeniu z async await słowami kluczowymi i w Visual Basic i C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Użyj CanRead właściwości, aby określić, czy bieżące wystąpienie obsługuje odczytywanie.Use the CanRead property to determine whether the current instance supports reading.

Jeśli operacja zostanie anulowana przed zakończeniem, zwrócone zadanie zawiera TaskStatus.Canceled wartość Status właściwości.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Status property. Jeśli dojście do pliku zostanie usunięte, zwrócone zadanie zawiera ObjectDisposedException wyjątek we Task.Exception właściwości.If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Task.Exception property.

Dotyczy

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

Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia plików i zapisuje je w tablicy bajtów Zaczynając od określonego przesunięcia, przesuwa pozycję w strumieniu pliku o liczbę odczytanych bajtów i monitoruje żądania anulowania.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)

Parametry

buffer
Byte[]

Bufor, w którym mają zostać zapisane dane.The buffer to write the data into.

offset
Int32

Przesunięcie bajtu, w buffer którym rozpocznie się zapisywanie danych ze strumienia.The byte offset in buffer at which to begin writing data from the stream.

count
Int32

Maksymalna liczba bajtów do odczytania.The maximum number of bytes to read.

cancellationToken
CancellationToken

Token do monitorowania żądań anulowania.The token to monitor for cancellation requests.

Zwraca

Task<Int32>

Zadanie, które reprezentuje asynchroniczną operację odczytu i otacza całkowitą liczbę bajtów odczytywanych w buforze.A task that represents the asynchronous read operation and wraps the total number of bytes read into the buffer. Wartość wynikowa może być mniejsza niż liczba żądanych bajtów, jeśli liczba aktualnie dostępnych bajtów jest mniejsza niż żądana liczba, lub może być równa 0 (zero), jeśli osiągnięto koniec strumienia.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.

Atrybuty

Wyjątki

buffer to null.buffer is null.

offset lub count jest ujemna.offset or count is negative.

Suma offset i count jest większa niż długość buforu.The sum of offset and count is larger than the buffer length.

Strumień nie obsługuje odczytywania.The stream does not support reading.

Strumień został usunięty.The stream has been disposed.

Strumień jest obecnie używany przez poprzednią operację odczytu.The stream is currently in use by a previous read operation.

Przykłady

Poniższy przykład pokazuje, jak odczytywać asynchronicznie z pliku.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

Uwagi

ReadAsyncMetoda ta umożliwia wykonywanie operacji na plikach intensywnie korzystających z zasobów bez blokowania wątku głównego.The ReadAsync method enables you to perform resource-intensive file operations without blocking the main thread. Ten wpływ na wydajność jest szczególnie istotny w aplikacji do sklepu Windows 8. x lub aplikacji klasycznej, w której czasochłonna operacja przesyłania strumieniowego może blokować wątek interfejsu użytkownika i sprawiać, że aplikacja wygląda tak, jakby nie działała.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. Metody asynchroniczne są używane w połączeniu z async await słowami kluczowymi i w Visual Basic i C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Użyj CanRead właściwości, aby określić, czy bieżące wystąpienie obsługuje odczytywanie.Use the CanRead property to determine whether the current instance supports reading.

Jeśli operacja zostanie anulowana przed zakończeniem, zwrócone zadanie zawiera TaskStatus.Canceled wartość Task.Status właściwości.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property. Jeśli dojście do pliku zostanie usunięte, zwrócone zadanie zawiera ObjectDisposedException wyjątek we Task.Exception właściwości.If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Task.Exception property.

Dotyczy