FileStream.ReadAsync Método

Definição

Sobrecargas

ReadAsync(Memory<Byte>, CancellationToken)

Lê de forma assíncrona uma sequência de bytes do fluxo de arquivo atual e grava-os em uma região de memória, avança a posição no fluxo de arquivo até o número de bytes lidos e monitora as solicitações de cancelamento.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)

Lê de forma assíncrona uma sequência de bytes do fluxo de arquivo atual, grava-os em uma matriz de bytes começando no deslocamento especificado, avança a posição no fluxo de arquivo até o número de bytes lidos e monitora as solicitações de cancelamento.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)

Lê de forma assíncrona uma sequência de bytes do fluxo de arquivo atual e grava-os em uma região de memória, avança a posição no fluxo de arquivo até o número de bytes lidos e monitora as solicitações de cancelamento.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)

Parâmetros

buffer
Memory<Byte>

O buffer no qual os dados serão gravados.The buffer to write the data into.

cancellationToken
CancellationToken

O token a se monitorar para solicitações de cancelamento.The token to monitor for cancellation requests. O valor padrão é None.The default value is None.

Retornos

ValueTask<Int32>

Uma tarefa que representa a operação de leitura assíncrona e encapsula o número total de bytes lidos no buffer.A task that represents the asynchronous read operation and wraps the total number of bytes read into the buffer. O valor do resultado poderá ser menor que o número de bytes solicitados se o número de bytes disponíveis no momento for menor que o número solicitado ou poderá ser 0 (zero) se o final do fluxo foi atingido.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.

Exemplos

O exemplo a seguir mostra como ler de um arquivo de forma assíncrona.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

Comentários

O ReadAsync método permite que você execute operações de arquivo com uso intensivo de recursos sem bloquear o thread principal.The ReadAsync method enables you to perform resource-intensive file operations without blocking the main thread. Essa consideração sobre o desempenho é particularmente importante em um aplicativo Windows Store 8.xWindows 8.x Store ou área de trabalhodesktop em que uma operação demorada de fluxo pode bloquear o thread de interface do usuário e fazer seu aplicativo parecer como se não estivesse funcionando.This performance consideration is particularly important in a Windows Store 8.xWindows 8.x Store app or área de trabalhodesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Os métodos assíncronos são usados em conjunto com async as await palavras-chave e em Visual Basic e C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Use a CanRead propriedade para determinar se a instância atual oferece suporte à leitura.Use the CanRead property to determine whether the current instance supports reading.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá o TaskStatus.Canceled valor da Status propriedade.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Status property. Se o identificador para o arquivo for descartado, a tarefa retornada conterá a ObjectDisposedException exceção na Task.Exception propriedade.If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Task.Exception property.

Aplica-se a

Produto Introduced

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

Lê de forma assíncrona uma sequência de bytes do fluxo de arquivo atual, grava-os em uma matriz de bytes começando no deslocamento especificado, avança a posição no fluxo de arquivo até o número de bytes lidos e monitora as solicitações de cancelamento.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)

Parâmetros

buffer
Byte[]

O buffer no qual os dados serão gravados.The buffer to write the data into.

offset
Int32

O deslocamento de bytes no buffer no qual será iniciada a gravação de dados no fluxo.The byte offset in buffer at which to begin writing data from the stream.

count
Int32

O número máximo de bytes a serem lidos.The maximum number of bytes to read.

cancellationToken
CancellationToken

O token a se monitorar para solicitações de cancelamento.The token to monitor for cancellation requests.

Retornos

Task<Int32>

Uma tarefa que representa a operação de leitura assíncrona e encapsula o número total de bytes lidos no buffer.A task that represents the asynchronous read operation and wraps the total number of bytes read into the buffer. O valor do resultado poderá ser menor que o número de bytes solicitados se o número de bytes disponíveis no momento for menor que o número solicitado ou poderá ser 0 (zero) se o final do fluxo foi atingido.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.

Atributos

Exceções

buffer é null.buffer is null.

offset ou count é negativo.offset or count is negative.

A soma de offset e count é maior que o tamanho do buffer.The sum of offset and count is larger than the buffer length.

Não há suporte para leitura no fluxo.The stream does not support reading.

O fluxo foi descartado.The stream has been disposed.

O fluxo está sendo usado no momento por uma operação de leitura anterior.The stream is currently in use by a previous read operation.

Exemplos

O exemplo a seguir mostra como ler de um arquivo de forma assíncrona.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

Comentários

O ReadAsync método permite que você execute operações de arquivo com uso intensivo de recursos sem bloquear o thread principal.The ReadAsync method enables you to perform resource-intensive file operations without blocking the main thread. Essa consideração sobre o desempenho é particularmente importante em um aplicativo Windows Store 8.xWindows 8.x Store ou área de trabalhodesktop em que uma operação demorada de fluxo pode bloquear o thread de interface do usuário e fazer seu aplicativo parecer como se não estivesse funcionando.This performance consideration is particularly important in a Windows Store 8.xWindows 8.x Store app or área de trabalhodesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Os métodos assíncronos são usados em conjunto com async as await palavras-chave e em Visual Basic e C#.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Use a CanRead propriedade para determinar se a instância atual oferece suporte à leitura.Use the CanRead property to determine whether the current instance supports reading.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá o TaskStatus.Canceled valor da Task.Status propriedade.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property. Se o identificador para o arquivo for descartado, a tarefa retornada conterá a ObjectDisposedException exceção na Task.Exception propriedade.If the handle to the file is disposed, the returned task contains the ObjectDisposedException exception in the Task.Exception property.

Confira também

Aplica-se a

Produto Introduced