Stream.ReadAsync Method

Definition

Lê uma sequência de bytes do fluxo atual de forma assíncrona e avança a posição no fluxo até o número de bytes lidos.Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Overloads

ReadAsync(Memory<Byte>, CancellationToken)

Lê de forma assíncrona uma sequência de bytes do fluxo atual, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

ReadAsync(Byte[], Int32, Int32)

Lê uma sequência de bytes do fluxo atual de forma assíncrona e avança a posição no fluxo até o número de bytes lidos.Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

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

Lê de forma assíncrona uma sequência de bytes do fluxo atual, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.Asynchronously reads a sequence of bytes from the current stream, advances the position within the 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 atual, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

public virtual System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overridable Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = null) As ValueTask(Of Integer)

Parameters

buffer
Memory<Byte>

A região da memória na qual gravar os dados.The region of memory to write the data into.

cancellationToken
CancellationToken

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

Returns

ValueTask<Int32>

Uma tarefa que representa a operação de leitura assíncrona.A task that represents the asynchronous read operation. O valor de sua propriedade Result contém o número total de bytes lidos no buffer.The value of its Result property contains the total number of bytes read into the buffer. O valor do resultado poderá ser menor que o número de bytes alocados no buffer se esses muitos bytes não estiverem disponíveis no momento, ou zero (0), se o final do fluxo tiver sido atingido.The result value can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the stream has been reached.

Remarks

O método ReadAsync permite que você execute operações de e/s com uso intensivo de recursos sem bloquear o thread principal.The ReadAsync method enables you to perform resource-intensive I/O 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 as palavras-chave async e await no Visual Basic C#e no.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Use a propriedade CanRead 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 valor TaskStatus.Canceled para a propriedade Status.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Status property.

Para obter um exemplo, consulte a sobrecarga de ReadAsync(Byte[], Int32, Int32).For an example, see the ReadAsync(Byte[], Int32, Int32) overload.

ReadAsync(Byte[], Int32, Int32)

Lê uma sequência de bytes do fluxo atual de forma assíncrona e avança a posição no fluxo até o número de bytes lidos.Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

public:
 System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count);
public System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count);
member this.ReadAsync : byte[] * int * int -> System.Threading.Tasks.Task<int>
Public Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer) As Task(Of Integer)

Parameters

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 ler.The maximum number of bytes to read.

Returns

Task<Int32>

Uma tarefa que representa a operação de leitura assíncrona.A task that represents the asynchronous read operation. O valor do parâmetro TResult contém o número total de bytes lidos no buffer.The value of the TResult parameter contains 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.

Attributes

Exceptions

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.

Examples

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. O exemplo usa a classe FileStream, que deriva da classe Stream.The example uses the FileStream class, which derives from the Stream class.

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

Remarks

O método ReadAsync permite que você execute operações de e/s com uso intensivo de recursos sem bloquear o thread principal.The ReadAsync method enables you to perform resource-intensive I/O 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 as palavras-chave async e await no Visual Basic C#e no.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

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

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

Lê de forma assíncrona uma sequência de bytes do fluxo atual, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);
public virtual System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
abstract member ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
Public Overridable Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Parameters

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 ler.The maximum number of bytes to read.

cancellationToken
CancellationToken

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

Returns

Task<Int32>

Uma tarefa que representa a operação de leitura assíncrona.A task that represents the asynchronous read operation. O valor do parâmetro TResult contém o número total de bytes lidos no buffer.The value of the TResult parameter contains 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.

Attributes

Exceptions

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.

Remarks

O método ReadAsync permite que você execute operações de e/s com uso intensivo de recursos sem bloquear o thread principal.The ReadAsync method enables you to perform resource-intensive I/O 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 as palavras-chave async e await no Visual Basic C#e no.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Use a propriedade CanRead 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 valor Canceled para a propriedade Status.If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

Para obter um exemplo, consulte a sobrecarga de ReadAsync(Byte[], Int32, Int32).For an example, see the ReadAsync(Byte[], Int32, Int32) overload.

See also

Applies to