StreamWriter.WriteLineAsync Method (String)

.NET Framework 4.6 and 4.5

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

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

'Declaration
<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 Nothing, only a line terminator is written.

Return Value

Type: System.Threading.Tasks.Task
A task that represents the asynchronous write operation.

ExceptionCondition
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.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

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

.NET Framework

Supported in: 4.6, 4.5

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft