StreamWriter.WriteAsync Method (String)

.NET Framework (current version)
 
System_CAPS_noteNote

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

Writes a string to the stream asynchronously.

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

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

Parameters

value
Type: System.String

The string to write to the stream. If value is null, nothing 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 following example shows how to write a string to a text file by using the WriteAsync(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.WriteAsync("Example text as string")
        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: