Export (0) Print
Expand All

StringWriter.WriteLineAsync Method (String)

.NET Framework 4.5

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

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.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 string writer is disposed.

InvalidOperationException

The string 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 a string by using the WriteLineAsync(String) method.

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim stringToWrite As StringBuilder = New StringBuilder("Characters in StringBuilder")
        stringToWrite.AppendLine()

        Using writer As StringWriter = New StringWriter(stringToWrite)
            Await writer.WriteLineAsync("and add characters through StringWriter")
            Console.WriteLine(stringToWrite.ToString())
        End Using 
    End Sub 
End Module 
' The example displays the following output: 

' Characters in StringBuilder 
' and add characters through StringWriter 
'

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft