StreamReader.ReadToEndAsync Método

Definición

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

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

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync();
public override System.Threading.Tasks.Task<string> ReadToEndAsync();
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<string> ReadToEndAsync();
override this.ReadToEndAsync : unit -> System.Threading.Tasks.Task<string>
[<System.Runtime.InteropServices.ComVisible(false)>]
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 TResult parámetro contiene una cadena con los caracteres de la posición actual hasta el final de la secuencia.

Atributos
ComVisibleAttribute

Excepciones

ArgumentOutOfRangeException

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

ObjectDisposedException

Se ha eliminado la secuencia.

InvalidOperationException

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

Ejemplos

En el ejemplo siguiente se muestra cómo leer el contenido de un archivo mediante el ReadToEndAsync() método .

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static async Task Main()
        {
            await ReadCharacters();
        }

        static async Task ReadCharacters()
        {
            String result;
            using (StreamReader reader = File.OpenText("existingfile.txt"))
            {
                Console.WriteLine("Opened file.");
                result = await reader.ReadToEndAsync();
                Console.WriteLine("Contains: " + result);
            }
        }
    }
}

Imports System.IO

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim result As String

        Using reader As StreamReader = File.OpenText("existingfile.txt")
            Console.WriteLine("Opened file.")
            result = Await reader.ReadToEndAsync()
            Console.WriteLine("Contains: " + result)
        End Using
    End Sub
End Module

Comentarios

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 ReadToEnd().

Se aplica a