StringReader.ReadAsync Método

Definición

Espacio de nombres:
System.IO
Ensamblado:
netstandard.dll
Ensamblados:
mscorlib.dll, System.IO.dll
Ensamblado:
mscorlib.dll
Ensamblado:
System.IO.dll

Sobrecargas

Nombre Description
ReadAsync(Memory<Char>, CancellationToken)

Lee de forma asincrónica todos los caracteres de la cadena de entrada, comenzando en la posición actual y avanza la posición actual hasta el final de la cadena de entrada.
ReadAsync(Char[], Int32, Int32)

Lee un número máximo especificado de caracteres de la cadena actual de forma asincrónica y escribe los datos en un búfer, empezando por el índice especificado.

ReadAsync(Memory<Char>, CancellationToken)

Lee de forma asincrónica todos los caracteres de la cadena de entrada, comenzando en la posición actual y avanza la posición actual hasta el final de la cadena de entrada.

public override System.Threading.Tasks.ValueTask<int> ReadAsync(Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overrides Function ReadAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parámetros

buffer
Memory<Char>

Cuando este método vuelve, contiene los caracteres leídos del origen actual.

cancellationToken
CancellationToken

Token que se va a supervisar para las solicitudes de cancelación. El valor por defecto es None.

Devoluciones

ValueTask<Int32>

Tarea que representa la operación de lectura asincrónica. El valor del TResult parámetro contiene el número total de caracteres leídos en el búfer.

Excepciones

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Se aplica a

ReadAsync(Char[], Int32, Int32)

Lee un número máximo especificado de caracteres de la cadena actual de forma asincrónica y escribe los datos en un búfer, empezando por el índice especificado.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);
public override System.Threading.Tasks.Task<int> ReadAsync(char[] buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadAsync(char[] buffer, int index, int count);
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

Parámetros

buffer
Char[]

Cuando este método devuelve, contiene la matriz de caracteres especificada con los valores entre index y (index + count - 1) reemplazados por los caracteres leídos del origen actual.

index
Int32

Posición en la buffer que se va a empezar a escribir.

count
Int32

Número máximo de caracteres que se van a leer. Si se alcanza el final de la cadena antes de escribir el número especificado de caracteres en el búfer, el método devuelve.

Devoluciones

Task<Int32>

Tarea que representa la operación de lectura asincrónica. El valor del TResult parámetro 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 disponible actualmente es menor que el número solicitado, o puede ser 0 (cero) si se ha alcanzado el final de la cadena.

Atributos
ComVisibleAttribute

Excepciones

ArgumentNullException

buffer es null.

ArgumentOutOfRangeException

index o count es negativo.

ArgumentException

La suma de index y count es mayor que la longitud del búfer.

ObjectDisposedException

Se ha eliminado el lector de cadenas.

InvalidOperationException

El lector está actualmente en uso mediante una operación de lectura anterior.

Ejemplos

En el ejemplo siguiente se muestra cómo leer los primeros 23 caracteres de una cadena de forma asincrónica.

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            ReadCharacters();
        }

        static async void ReadCharacters()
        {
            string stringToRead = "Some characters to read but not all";
            char[] charsRead = new char[stringToRead.Length];

            using (StringReader reader = new StringReader(stringToRead))
            {
                await reader.ReadAsync(charsRead, 0, 23);
                Console.WriteLine(charsRead);
            }
        }
    }
}
// The example displays the following output:
// Some characters to read
//

Imports System.IO

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim stringToRead = "Some characters to read but not all"
        Dim charsRead(stringToRead.Length) As Char

        Using reader As StringReader = New StringReader(stringToRead)
            Await reader.ReadAsync(charsRead, 0, 23)
            Console.WriteLine(charsRead)
        End Using
    End Sub

End Module
' The example displays the following output:
' Some characters to read
'

Comentarios

La tarea se completa después de que se lea el número de caracteres especificados por el count parámetro o se alcance el final de la cadena.

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(Char[], Int32, Int32).

Se aplica a