StreamReader.ReadLineAsync Método

Definición

Espacio de nombres:

System.IO

Ensamblado:

System.Runtime.dll

Sobrecargas

ReadLineAsync()	Lee de forma asincrónica una línea de caracteres de la secuencia actual y devuelve los datos como una cadena.
ReadLineAsync(CancellationToken)	Lee de forma asincrónica una línea de caracteres de la secuencia actual y devuelve los datos como una cadena.

ReadLineAsync()

Source:

StreamReader.cs

Lee de forma asincrónica una línea de caracteres de la secuencia actual y devuelve los datos como una cadena.

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

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

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

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

Devoluciones

Task<String>

Tarea que representa la operación de lectura asincrónica. El valor del parámetro TResult contiene la línea siguiente de la secuencia, o es null si se han leído todos los caracteres.

Excepciones

ArgumentOutOfRangeException

El número de caracteres de la línea siguiente es mayor que Int32.MaxValue.

ObjectDisposedException

Se ha eliminado la secuencia.

InvalidOperationException

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

Ejemplos

En el ejemplo siguiente se muestra cómo leer la primera línea de un archivo mediante el ReadLineAsync() 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.ReadLineAsync();
                Console.WriteLine("First line 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.ReadLineAsync()
            Console.WriteLine("First line contains: " + result)
        End Using
    End Sub
End Module

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, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, se siguen iniciando de forma sincrónica. Para ver las excepciones almacenadas, consulte las excepciones producidas por ReadLine().

ReadLineAsync(CancellationToken)

Source:

StreamReader.cs

Lee de forma asincrónica una línea de caracteres de la secuencia actual y devuelve los datos como una cadena.

public:
 override System::Threading::Tasks::ValueTask<System::String ^> ReadLineAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.ValueTask<string?> ReadLineAsync (System.Threading.CancellationToken cancellationToken);

override this.ReadLineAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<string>

Public Overrides Function ReadLineAsync (cancellationToken As CancellationToken) As ValueTask(Of String)

Parámetros

cancellationToken

CancellationToken

Token para supervisar solicitudes de cancelación.

Devoluciones

ValueTask<String>

Una tarea de valor que representa la operación de lectura asincrónica. El valor del TResult parámetro contiene la siguiente línea de la secuencia o es null si se han leído todos los caracteres.

Excepciones

ArgumentOutOfRangeException

El número de caracteres de la línea siguiente es mayor que Int32.MaxValue.

ObjectDisposedException

Se ha eliminado el lector de secuencias.

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

Si este método se cancela a través cancellationTokende , es posible que se pierdan algunos datos leídos del objeto actual Stream pero no almacenados (por ) StreamReadero devueltos (al autor de la llamada).

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, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, se siguen iniciando de forma sincrónica. Para ver las excepciones almacenadas, consulte las excepciones producidas por ReadLine().