BufferedStream.ReadAsync(Byte[], Int32, Int32, CancellationToken) Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Lee de forma asincrónica una secuencia de bytes de la secuencia actual, avanza la posición dentro de la secuencia por el número de bytes leídos y supervisa las solicitudes de cancelación.
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);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[]
Búfer en el que se van a escribir los datos.
- offset
- Int32
Desplazamiento de bytes en el buffer que se van a empezar a escribir datos de la secuencia.
- count
- Int32
Número máximo de bytes que se van a leer.
- cancellationToken
- CancellationToken
Token que se va a supervisar para las solicitudes de cancelación.
Devoluciones
Tarea que representa la operación de lectura asincrónica. La tarea devuelta contiene el número total de bytes leídos en el búfer. El valor de resultado puede ser menor que el número de bytes solicitado si el número de bytes actualmente disponible es menor que el número solicitado, o puede ser 0 (cero) si se ha alcanzado el final de la secuencia.
Excepciones
buffer es null.
offset o count es negativo.
La suma de offset y count es mayor que la longitud del búfer.
La secuencia no admite la lectura.
Se ha eliminado la secuencia.
La secuencia está actualmente en uso mediante una operación de lectura anterior.
Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.
Comentarios
Puede crear un token de cancelación creando una instancia de la CancellationTokenSource clase y pasando la Token propiedad como parámetro cancellationToken .
Este método almacena en la tarea que devuelve todas las excepciones de no uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, todavía se producen sincrónicamente. Para las excepciones almacenadas, consulte las excepciones producidas por Read(Byte[], Int32, Int32).