StringReader.ReadLineAsync Method ()

.NET Framework (current version)

The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Reads a line of characters asynchronously from the current string and returns the data as a string.

Namespace:   System.IO
Assembly:  mscorlib (in mscorlib.dll)

Public Overrides Function ReadLineAsync As Task(Of String)

Return Value

Type: System.Threading.Tasks.Task(Of String)

A task that represents the asynchronous read operation. The value of the TResult parameter contains the next line from the string reader, or is null if all the characters have been read.

Exception Condition

The number of characters in the next line is larger than MaxValue.


The string reader has been disposed.


The reader is currently in use by a previous read operation.

The following example shows how to read one line at a time from a string asynchronously.

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
    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)
                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

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top