FileStream.ReadAsync FileStream.ReadAsync FileStream.ReadAsync Method

Definition

Überlädt

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

Liest eine Folge von Bytes asynchron aus dem aktuellen Dateidatenstrom, schreibt diese in einen Speicherbereich, erhöht die Position im Dateidatenstrom um die Anzahl der gelesenen Bytes und überwacht Abbruchsanforderungen.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)

Liest eine Folge von Bytes asynchron aus dem aktuellen Dateidatenstrom, schreibt diese beginnend bei einem angegebenen Offset in ein Bytearray, erhöht die Position im Dateidatenstrom um die Anzahl der gelesenen Bytes und überwacht Abbruchsanforderungen.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)

Liest eine Folge von Bytes asynchron aus dem aktuellen Dateidatenstrom, schreibt diese in einen Speicherbereich, erhöht die Position im Dateidatenstrom um die Anzahl der gelesenen Bytes und überwacht Abbruchsanforderungen.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>

Parameter

buffer
Memory<Byte>

Der Puffer, in den die Daten geschrieben werden sollen.The buffer to write the data into.

cancellationToken
CancellationToken CancellationToken CancellationToken

Das Token zum Überwachen von Abbruchanforderungen.The token to monitor for cancellation requests. Der Standardwert ist Nonesein.The default value is None.

Gibt zurück

Eine Aufgabe, die den asynchronen Lesevorgang darstellt und die Gesamtzahl der in den Puffer gelesenen Bytes umschließt.A task that represents the asynchronous read operation and wraps the total number of bytes read into the buffer. Der Ergebniswert kann niedriger als die Anzahl der angeforderten Bytes sein, wenn die Anzahl an derzeit verfügbaren Bytes kleiner ist als die angeforderte Anzahl, oder sie kann 0 (null) sein, wenn das Datenstromende erreicht ist.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.

Beispiele

Im folgenden Beispiel wird gezeigt, wie Sie asynchron aus einer Datei lesen.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

Hinweise

Die ReadAsync -Methode ermöglicht es Ihnen, ressourcenintensive Datei Vorgänge auszuführen, ohne den Haupt Thread zu blockieren.The ReadAsync method enables you to perform resource-intensive file operations without blocking the main thread. Diese Überlegungen zur Leistung sind insbesondere in einer Windows 8.x StoreWindows 8.x Store -App oder Desktopdesktop -App wichtig, bei der ein zeitaufwendiger Streamvorgang den UI-Thread blockieren kann und es dann den Anschein hat, dass Ihre App nicht funktioniert.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. Die Async-Methoden werden in Verbindung mit den async Schlüssel await Wörtern und in Visual Basic C#und verwendet.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Verwenden Sie CanRead die-Eigenschaft, um zu bestimmen, ob die aktuelle Instanz Lesevorgänge unterstütztUse the CanRead property to determine whether the current instance supports reading.

Wenn der Vorgang abgebrochen wird, bevor er abgeschlossen ist, enthält die TaskStatus.Canceled zurückgegebene Aufgabe Status den Wert für die-Eigenschaft.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Status property. Wenn das Handle für die Datei verworfen wird, enthält die zurückgegebene Aufgabe ObjectDisposedException die Ausnahme in Task.Exception der-Eigenschaft.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)

Liest eine Folge von Bytes asynchron aus dem aktuellen Dateidatenstrom, schreibt diese beginnend bei einem angegebenen Offset in ein Bytearray, erhöht die Position im Dateidatenstrom um die Anzahl der gelesenen Bytes und überwacht Abbruchsanforderungen.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>

Parameter

buffer
Byte[]

Der Puffer, in den die Daten geschrieben werden sollen.The buffer to write the data into.

offset
Int32 Int32 Int32

Der Byteoffset im buffer, ab dem Daten aus dem Stream geschrieben werden.The byte offset in buffer at which to begin writing data from the stream.

count
Int32 Int32 Int32

Die maximale Anzahl der zu lesenden Bytes.The maximum number of bytes to read.

cancellationToken
CancellationToken CancellationToken CancellationToken

Das Token zum Überwachen von Abbruchanforderungen.The token to monitor for cancellation requests.

Gibt zurück

Eine Aufgabe, die den asynchronen Lesevorgang darstellt und die Gesamtzahl der in den Puffer gelesenen Bytes umschließt.A task that represents the asynchronous read operation and wraps the total number of bytes read into the buffer. Der Ergebniswert kann niedriger als die Anzahl der angeforderten Bytes sein, wenn die Anzahl an derzeit verfügbaren Bytes kleiner ist als die angeforderte Anzahl, oder sie kann 0 (null) sein, wenn das Datenstromende erreicht ist.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.

Ausnahmen

offset oder count ist ein negativer Wert.offset or count is negative.

Die Summe von offset und count ist größer als die Pufferlänge.The sum of offset and count is larger than the buffer length.

Lesevorgänge werden vom Stream nicht unterstützt.The stream does not support reading.

Der Stream wurde verworfen.The stream has been disposed.

Der Stream wird zurzeit von einem vorherigen Lesevorgang verwendet.The stream is currently in use by a previous read operation.

Beispiele

Im folgenden Beispiel wird gezeigt, wie Sie asynchron aus einer Datei lesen.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

Hinweise

Die ReadAsync -Methode ermöglicht es Ihnen, ressourcenintensive Datei Vorgänge auszuführen, ohne den Haupt Thread zu blockieren.The ReadAsync method enables you to perform resource-intensive file operations without blocking the main thread. Diese Überlegungen zur Leistung sind insbesondere in einer Windows 8.x StoreWindows 8.x Store -App oder Desktopdesktop -App wichtig, bei der ein zeitaufwendiger Streamvorgang den UI-Thread blockieren kann und es dann den Anschein hat, dass Ihre App nicht funktioniert.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. Die Async-Methoden werden in Verbindung mit den async Schlüssel await Wörtern und in Visual Basic C#und verwendet.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Verwenden Sie CanRead die-Eigenschaft, um zu bestimmen, ob die aktuelle Instanz Lesevorgänge unterstütztUse the CanRead property to determine whether the current instance supports reading.

Wenn der Vorgang abgebrochen wird, bevor er abgeschlossen ist, enthält die TaskStatus.Canceled zurückgegebene Aufgabe Task.Status den Wert für die-Eigenschaft.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property. Wenn das Handle für die Datei verworfen wird, enthält die zurückgegebene Aufgabe ObjectDisposedException die Ausnahme in Task.Exception der-Eigenschaft.If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Task.Exception property.

Siehe auch

Gilt für: