Stream.ReadAsync Método

Definición

Lee asincrónicamente una secuencia de bytes de la secuencia actual y avanza la posición en esta secuencia según el número de bytes leídos.Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Sobrecargas

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

Lee de forma asincrónica una secuencia de bytes en la secuencia actual, se hace avanzar la posición dentro de la secuencia el número de bytes leídos y controla las solicitudes de cancelación.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)

Lee de forma asincrónica una secuencia de bytes en la secuencia actual, se hace avanzar la posición dentro de la secuencia el número de bytes leídos y controla las solicitudes de cancelación.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)

Lee asincrónicamente una secuencia de bytes de la secuencia actual y avanza la posición en esta secuencia según el número de bytes leídos.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)

Lee de forma asincrónica una secuencia de bytes en la secuencia actual, se hace avanzar la posición dentro de la secuencia el número de bytes leídos y controla las solicitudes de cancelación.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);
[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>

Parámetros

buffer
Byte[]

El búfer en el que se escriben los datos.The buffer to write the data into.

offset
Int32

Posición de desplazamiento en bytes de buffer donde se comienza a escribir los datos del flujo.The byte offset in buffer at which to begin writing data from the stream.

count
Int32

Número máximo de bytes que se pueden leer.The maximum number of bytes to read.

cancellationToken
CancellationToken

Token para supervisar solicitudes de cancelación.The token to monitor for cancellation requests. El valor predeterminado es None.The default value is None.

Devoluciones

Tarea que representa la operación de lectura asincrónica.A task that represents the asynchronous read operation. El valor del parámetro TResult contiene el número total de bytes leídos en el búfer.The value of the TResult parameter contains the total number of bytes read into the buffer. El valor del resultado puede ser menor que el número de bytes solicitados si el número de bytes disponibles actualmente es menor que el número solicitado o puede ser 0 (cero) si se ha llegado al final de la secuencia.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

Excepciones

buffer es null.buffer is null.

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

La suma de offset y count es mayor que la longitud del búfer.The sum of offset and count is larger than the buffer length.

La secuencia no admite lectura.The stream does not support reading.

Se ha eliminado la secuencia.The stream has been disposed.

Una operación de lectura anterior está usando actualmente la secuencia.The stream is currently in use by a previous read operation.

Comentarios

El ReadAsync método le permite realizar operaciones de e/s con un uso intensivo de recursos sin bloquear el subproceso principal.The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Esta consideración de rendimiento es especialmente importante en una aplicación de la Tienda Windows 8.xWindows 8.x Store o una aplicación de escritoriodesktop en que una operación de streaming prolongada puede bloquear el subproceso de interfaz de usuario y hacer que parezca que una aplicación ha dejado de responder.This performance consideration is particularly important in a Tienda Windows 8.xWindows 8.x Store app or escritoriodesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Los métodos asincrónicos se utilizan junto con las async palabras await clave y en Visual Basic C#y.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Utilice la CanRead propiedad para determinar si la instancia actual admite operaciones de lectura.Use the CanRead property to determine whether the current instance supports reading.

Si la operación se cancela antes de que se complete, la tarea devuelta contiene Canceled el valor de Status la propiedad.If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

Para obtener un ejemplo, vea ReadAsync(Byte[], Int32, Int32) la sobrecarga.For an example, see the ReadAsync(Byte[], Int32, Int32) overload.

Consulte también:

ReadAsync(Memory<Byte>, CancellationToken)

Lee de forma asincrónica una secuencia de bytes en la secuencia actual, se hace avanzar la posición dentro de la secuencia el número de bytes leídos y controla las solicitudes de cancelación.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 = null);
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>

Parámetros

buffer
Memory<Byte>

Región de memoria en la que se van a escribir los datos.The region of memory to write the data into.

cancellationToken
CancellationToken

Token para supervisar solicitudes de cancelación.The token to monitor for cancellation requests. El valor predeterminado es None.The default value is None.

Devoluciones

Tarea que representa la operación de lectura asincrónica.A task that represents the asynchronous read operation. El valor de su propiedad Result contiene el número total de bytes leídos en el búfer.The value of its Result property contains the total number of bytes read into the buffer. El valor de resultado puede ser menor que el número de bytes asignado en el búfer si esos bytes no están disponibles en ese momento o 0 (cero) si se ha alcanzado el final de la secuencia.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.

Comentarios

El ReadAsync método le permite realizar operaciones de e/s con un uso intensivo de recursos sin bloquear el subproceso principal.The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Esta consideración de rendimiento es especialmente importante en una aplicación de la Tienda Windows 8.xWindows 8.x Store o una aplicación de escritoriodesktop en que una operación de streaming prolongada puede bloquear el subproceso de interfaz de usuario y hacer que parezca que una aplicación ha dejado de responder.This performance consideration is particularly important in a Tienda Windows 8.xWindows 8.x Store app or escritoriodesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Los métodos asincrónicos se utilizan junto con las async palabras await clave y en Visual Basic C#y.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Utilice la CanRead propiedad para determinar si la instancia actual admite operaciones de lectura.Use the CanRead property to determine whether the current instance supports reading.

Si la operación se cancela antes de que se complete, la tarea devuelta contiene TaskStatus.Canceled el valor de Status la propiedad.If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Status property.

Para obtener un ejemplo, vea ReadAsync(Byte[], Int32, Int32) la sobrecarga.For an example, see the ReadAsync(Byte[], Int32, Int32) overload.

ReadAsync(Byte[], Int32, Int32)

Lee asincrónicamente una secuencia de bytes de la secuencia actual y avanza la posición en esta secuencia según el número de bytes leídos.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);
[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)

Parámetros

buffer
Byte[]

El búfer en el que se escriben los datos.The buffer to write the data into.

offset
Int32

Posición de desplazamiento en bytes de buffer donde se comienza a escribir los datos del flujo.The byte offset in buffer at which to begin writing data from the stream.

count
Int32

Número máximo de bytes que se pueden leer.The maximum number of bytes to read.

Devoluciones

Tarea que representa la operación de lectura asincrónica.A task that represents the asynchronous read operation. El valor del parámetro TResult contiene el número total de bytes leídos en el búfer.The value of the TResult parameter contains the total number of bytes read into the buffer. El valor del resultado puede ser menor que el número de bytes solicitados si el número de bytes disponibles actualmente es menor que el número solicitado o puede ser 0 (cero) si se ha llegado al final de la secuencia.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

Excepciones

buffer es null.buffer is null.

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

La suma de offset y count es mayor que la longitud del búfer.The sum of offset and count is larger than the buffer length.

La secuencia no admite lectura.The stream does not support reading.

Se ha eliminado la secuencia.The stream has been disposed.

Una operación de lectura anterior está usando actualmente la secuencia.The stream is currently in use by a previous read operation.

Ejemplos

En el ejemplo siguiente se muestra cómo leer de un archivo de forma asincrónica.The following example shows how to read from a file asynchronously. En el ejemplo se FileStream usa la clase, que se deriva Stream de la clase.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

Comentarios

El ReadAsync método le permite realizar operaciones de e/s con un uso intensivo de recursos sin bloquear el subproceso principal.The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. Esta consideración de rendimiento es especialmente importante en una aplicación de la Tienda Windows 8.xWindows 8.x Store o una aplicación de escritoriodesktop en que una operación de streaming prolongada puede bloquear el subproceso de interfaz de usuario y hacer que parezca que una aplicación ha dejado de responder.This performance consideration is particularly important in a Tienda Windows 8.xWindows 8.x Store app or escritoriodesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. Los métodos asincrónicos se utilizan junto con las async palabras await clave y en Visual Basic C#y.The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

Utilice la CanRead propiedad para determinar si la instancia actual admite operaciones de lectura.Use the CanRead property to determine whether the current instance supports reading.

Se aplica a