StringWriter.WriteLineAsync Method

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

Asynchronously writes data to the string, followed by a line terminator.

Overloads

WriteLineAsync(StringBuilder, CancellationToken)	Asynchronously writes the string representation of the string builder to the current string, followed by a line terminator.
WriteLineAsync(Char)	Asynchronously writes a character to the string, followed by a line terminator.
WriteLineAsync(String)	Asynchronously writes a string to the current string, followed by a line terminator.
WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)	Asynchronously writes the string representation of the memory region of characters to the current string, followed by a line terminator.
WriteLineAsync(Char[], Int32, Int32)	asynchronously writes a subarray of characters to the string, followed by a line terminator.

WriteLineAsync(StringBuilder, CancellationToken)

Source:

StringWriter.cs

Asynchronously writes the string representation of the string builder to the current string, followed by a line terminator.

public override System.Threading.Tasks.Task WriteLineAsync (System.Text.StringBuilder? value, System.Threading.CancellationToken cancellationToken = default);

override this.WriteLineAsync : System.Text.StringBuilder * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function WriteLineAsync (value As StringBuilder, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

value

StringBuilder

The string builder to write to the string.

cancellationToken

CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by WriteLine(StringBuilder).

WriteLineAsync(Char)

Source:

StringWriter.cs

Asynchronously writes a character to the string, followed by a line terminator.

public:
 override System::Threading::Tasks::Task ^ WriteLineAsync(char value);

public override System.Threading.Tasks.Task WriteLineAsync (char value);

override this.WriteLineAsync : char -> System.Threading.Tasks.Task

Public Overrides Function WriteLineAsync (value As Char) As Task

Parameters

value

Char

The character to write to the string.

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

ObjectDisposedException

The string writer is disposed.

InvalidOperationException

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

Examples

The following example shows how to write characters by using the WriteLineAsync(Char) method.

using System;
using System.Text;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            StringBuilder stringToWrite = new StringBuilder("Characters in StringBuilder");
            stringToWrite.AppendLine();

            using (StringWriter writer = new StringWriter(stringToWrite))
            {
                UnicodeEncoding ue = new UnicodeEncoding();
                char[] charsToAdd = ue.GetChars(ue.GetBytes("and chars to add"));
                foreach (char c in charsToAdd)
                {
                    await writer.WriteLineAsync(c);
                }
                Console.WriteLine(stringToWrite.ToString());
            }
        }
    }
}
// The example displays the following output:
//
// Characters in StringBuilder
// a
// n
// d
//
// c
// h
// a
// r
// s
//
// t
// o
//
// a
// d
// d
//

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)

            Dim ue As UnicodeEncoding = New UnicodeEncoding()
            Dim charsToAdd() = ue.GetChars(ue.GetBytes("and chars to add"))
            For Each c As Char In charsToAdd
                Await writer.WriteLineAsync(c)
            Next
            Console.WriteLine(stringToWrite.ToString())
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in StringBuilder
' a
' n
' d 
'
' c
' h
' a
' r
' s
' 
' t
' o
'
' a
' d
' d
'

Remarks

The line terminator is defined by the NewLine property.

WriteLineAsync(String)

Source:

StringWriter.cs

Asynchronously writes a string to the current string, followed by a line terminator.

public:
 override System::Threading::Tasks::Task ^ WriteLineAsync(System::String ^ value);

public override System.Threading.Tasks.Task WriteLineAsync (string? value);

override this.WriteLineAsync : string -> System.Threading.Tasks.Task

Public Overrides Function WriteLineAsync (value As String) As Task

Parameters

value

String

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

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

ObjectDisposedException

The string writer is disposed.

InvalidOperationException

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

Examples

The following example shows how to write a string by using the WriteLineAsync(String) method.

using System;
using System.Text;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            StringBuilder stringToWrite = new StringBuilder("Characters in StringBuilder");
            stringToWrite.AppendLine();

            using (StringWriter writer = new StringWriter(stringToWrite))
            {
                await writer.WriteLineAsync("and add characters through StringWriter");
                Console.WriteLine(stringToWrite.ToString());
            }
        }
    }
}
// The example displays the following output:
//
// Characters in StringBuilder
// and add characters through StringWriter
//

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
'

Remarks

The line terminator is defined by the NewLine property.

WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)

Source:

StringWriter.cs

Asynchronously writes the string representation of the memory region of characters to the current string, followed by a line terminator.

public override System.Threading.Tasks.Task WriteLineAsync (ReadOnlyMemory<char> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.WriteLineAsync : ReadOnlyMemory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function WriteLineAsync (buffer As ReadOnlyMemory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

buffer

ReadOnlyMemory<Char>

A memory region of characters to write to the string.

cancellationToken

CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

WriteLineAsync(Char[], Int32, Int32)

Source:

StringWriter.cs

asynchronously writes a subarray of characters to the string, followed by a line terminator.

public:
 override System::Threading::Tasks::Task ^ WriteLineAsync(cli::array <char> ^ buffer, int index, int count);

public override System.Threading.Tasks.Task WriteLineAsync (char[] buffer, int index, int count);

override this.WriteLineAsync : char[] * int * int -> System.Threading.Tasks.Task

Public Overrides Function WriteLineAsync (buffer As Char(), index As Integer, count As Integer) As Task

Parameters

buffer

Char[]

The character array to write data from.

index

Int32

The position in the buffer at which to start reading data.

count

Int32

The maximum number of characters to write.

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

ArgumentNullException

buffer is null.

ArgumentException

The index plus count is greater than the buffer length.

ArgumentOutOfRangeException

index or count is negative.

ObjectDisposedException

The string writer is disposed.

InvalidOperationException

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

Examples

The following example shows how to write characters by using the WriteLineAsync(Char[], Int32, Int32) method.

using System;
using System.Text;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            StringBuilder stringToWrite = new StringBuilder("Characters in StringBuilder");
            stringToWrite.AppendLine();

            using (StringWriter writer = new StringWriter(stringToWrite))
            {
                UnicodeEncoding ue = new UnicodeEncoding();
                char[] charsToAdd = ue.GetChars(ue.GetBytes("and chars to add"));

                await writer.WriteLineAsync(charsToAdd, 0, charsToAdd.Length);

                Console.WriteLine(stringToWrite.ToString());
            }
        }
    }
}
// The example displays the following output:
//
// Characters in StringBuilder
// and chars to add
//

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)

            Dim ue As UnicodeEncoding = New UnicodeEncoding()
            Dim charsToAdd() = ue.GetChars(ue.GetBytes("and chars to add"))

            Await writer.WriteLineAsync(charsToAdd, 0, charsToAdd.Length)

            Console.WriteLine(stringToWrite.ToString())
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in StringBuilder
' and chars to add
'

Remarks

The line terminator is defined by the NewLine property.