StreamWriter.WriteAsync Method (Char(), Int32, Int32)

.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 subarray of characters to the stream asynchronously.

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

<ComVisibleAttribute(False)>
<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)>
Public Overrides Function WriteAsync (
	buffer As Char(),
	index As Integer,
	count As Integer
) As Task

Parameters

buffer
Type: System.Char()

A character array that contains the data to write.

index
Type: System.Int32

The character position in the buffer at which to begin reading data.

count
Type: System.Int32

The maximum number of characters to write.

Return Value

Type: System.Threading.Tasks.Task

A task that represents the asynchronous write operation.

Exception Condition
ArgumentNullException

buffer is null.

ArgumentException

The index plus count is greater than the buffer length.

ArgumentOutOfRangeException

index or count is negative.

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 multiple characters to a text file by using the WriteAsync(Char(), Int32, Int32) method.

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim ue As UnicodeEncoding = New UnicodeEncoding()
        Dim charsToAdd() = ue.GetChars(ue.GetBytes("Example string"))

        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteAsync(charsToAdd, 0, charsToAdd.Length)
        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: