Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

StreamWriter.WriteLineAsync Method (String)

.NET Framework (current version)
 

Writes a string followed by a line terminator asynchronously to the stream.

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

<ComVisibleAttribute(False)>
<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)>
Public Overrides Function WriteLineAsync (
	value As String
) As Task

Parameters

value
Type: System.String

The string to write. If the value is null, only a line terminator is written.

Return Value

Type: System.Threading.Tasks.Task

A task that represents the asynchronous write operation.

Exception Condition
ObjectDisposedException

The stream writer is disposed.

InvalidOperationException

The stream writer is currently in use by a previous write operation.

The line terminator is defined by the TextWriter.NewLine property.

The following example shows how to write two lines that consist of string values to a text file by using the WriteLineAsync(String) method.

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteLineAsync("First line of example")
            Await writer.WriteLineAsync("and second line")
        End Using
    End Sub
End Module

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
Show: