StringReader.ReadLineAsync Método

Definición

Espacio de nombres:

System.IO

Ensamblado:

mscorlib.dll

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

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

[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<string> ReadLineAsync();

[<System.Runtime.InteropServices.ComVisible(false)>]
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 TResult parámetro contiene la siguiente línea del lector de cadenas o es null si se han leído todos los caracteres.

Atributos

ComVisibleAttribute

Excepciones

ArgumentOutOfRangeException

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

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 una línea a la vez desde una cadena 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");

            string readText;

            using (StringReader reader = new StringReader(stringToRead.ToString()))
            {
                while ((readText = await reader.ReadLineAsync()) != null)
                {
                    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.ReadLineAsync()
            While Not IsNothing(readText)
                Console.WriteLine(readText)
                readText = Await reader.ReadLineAsync()
            End While
        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 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 ReadLine().