StringReader.ReadToEndAsync Método

Definición

Espacio de nombres:

System.IO

Ensamblado:

System.Runtime.dll

Sobrecargas

ReadToEndAsync()	Lee de forma asincrónica todos los caracteres desde la posición actual hasta el final de la cadena y los devuelve como una cadena única.
ReadToEndAsync(CancellationToken)	Lee de forma asincrónica todos los caracteres desde la posición actual hasta el final de la cadena y los devuelve como una cadena única.

ReadToEndAsync()

Source:

StringReader.cs

Lee de forma asincrónica todos los caracteres desde la posición actual hasta el final de la cadena y los devuelve como una cadena única.

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync();

public override System.Threading.Tasks.Task<string> ReadToEndAsync ();

override this.ReadToEndAsync : unit -> System.Threading.Tasks.Task<string>

Public Overrides Function ReadToEndAsync () As Task(Of String)

Devoluciones

Task<String>

Tarea que representa la operación de lectura asincrónica. El valor del parámetro TResult contiene una cadena con los caracteres desde la posición actual hasta el final de la cadena.

Excepciones

ArgumentOutOfRangeException

El número de caracteres es mayor que Int32.MaxValue.

ObjectDisposedException

El lector de cadenas se ha desechado.

InvalidOperationException

Una operación de lectura anterior está usando actualmente el lector.

Ejemplos

En el ejemplo siguiente se muestra cómo leer una cadena completa de forma asincrónica.

using System;
using System.IO;
using System.Text;

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

        static async void ReadCharacters()
        {
            StringBuilder stringToRead = new StringBuilder();
            stringToRead.AppendLine("Characters in 1st line to read");
            stringToRead.AppendLine("and 2nd line");
            stringToRead.AppendLine("and the end");

            using (StringReader reader = new StringReader(stringToRead.ToString()))
            {
                string readText = await reader.ReadToEndAsync();
                Console.WriteLine(readText);
            }
        }
    }
}
// The example displays the following output:
//
// Characters in 1st line to read
// and 2nd line
// and the end
//

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim stringToRead = New StringBuilder()
        stringToRead.AppendLine("Characters in 1st line to read")
        stringToRead.AppendLine("and 2nd line")
        stringToRead.AppendLine("and the end")

        Using reader As StringReader = New StringReader(stringToRead.ToString())
            Dim readText As String = Await reader.ReadToEndAsync()
            Console.WriteLine(readText)
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in 1st line to read
' and 2nd line
' and the end
'

Comentarios

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por ReadToEnd().

ReadToEndAsync(CancellationToken)

Source:

StringReader.cs

Lee de forma asincrónica todos los caracteres desde la posición actual hasta el final de la cadena y los devuelve como una cadena única.

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<string> ReadToEndAsync (System.Threading.CancellationToken cancellationToken);

override this.ReadToEndAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Overrides Function ReadToEndAsync (cancellationToken As CancellationToken) As Task(Of String)

Parámetros

cancellationToken

CancellationToken

Token para supervisar solicitudes de cancelación.

Devoluciones

Task<String>

Tarea que representa la operación de lectura asincrónica. El valor del parámetro TResult contiene una cadena con los caracteres desde la posición actual hasta el final de la cadena.

Excepciones

ArgumentOutOfRangeException

El número de caracteres es mayor que Int32.MaxValue.

ObjectDisposedException

El lector de cadenas se ha desechado.

InvalidOperationException

Una operación de lectura anterior está usando actualmente el lector.

OperationCanceledException

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

Comentarios

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por ReadToEnd().