TextWriter.WriteLineAsync Method

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

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

Overloads

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

Remarks

The TextWriter class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the WriteLineAsync method, see the StreamWriter.WriteLineAsync method.

WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)

Source:

TextWriter.cs

Asynchronously writes the text representation of a character memory region to the text stream, followed by a line terminator.

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

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

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

Parameters

buffer

ReadOnlyMemory<Char>

The character memory region to write to the text stream.

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

The line terminator is defined by the CoreNewLine field.

WriteLineAsync(String)

Source:

TextWriter.cs

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

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

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

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

Public Overridable 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 text writer is disposed.

InvalidOperationException

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

Remarks

The line terminator is defined by the CoreNewLine field.

The TextWriter class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the WriteLineAsync method, see the StreamWriter.WriteLineAsync method.

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(String).

See also

• WriteLineAsync(String)
• WriteLineAsync(String)

WriteLineAsync(Char[])

Source:

TextWriter.cs

Asynchronously writes an array of characters to the text stream, followed by a line terminator.

public:
 System::Threading::Tasks::Task ^ WriteLineAsync(cli::array <char> ^ buffer);

public System.Threading.Tasks.Task WriteLineAsync (char[]? buffer);

member this.WriteLineAsync : char[] -> System.Threading.Tasks.Task

Public Function WriteLineAsync (buffer As Char()) As Task

Parameters

buffer

Char[]

The character array to write to the text stream. If the character array is null, only the line terminator is written.

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

ObjectDisposedException

The text writer is disposed.

InvalidOperationException

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

Remarks

The line terminator is defined by the CoreNewLine field.

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(Char[]).

See also

• StreamWriter
• StringWriter

WriteLineAsync(Char[], Int32, Int32)

Source:

TextWriter.cs

Asynchronously writes a subarray of characters to the text stream, followed by a line terminator.

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

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

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

Public Overridable 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 character position in the buffer at which to start retrieving data.

count

Int32

The 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 text writer is disposed.

InvalidOperationException

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

Remarks

The line terminator is defined by the CoreNewLine field.

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(Char[], Int32, Int32).

See also

• WriteLineAsync(Char[], Int32, Int32)
• WriteLineAsync(Char[], Int32, Int32)

WriteLineAsync()

Source:

TextWriter.cs

Asynchronously writes a line terminator to the text stream.

public:
 virtual System::Threading::Tasks::Task ^ WriteLineAsync();

public virtual System.Threading.Tasks.Task WriteLineAsync ();

abstract member WriteLineAsync : unit -> System.Threading.Tasks.Task
override this.WriteLineAsync : unit -> System.Threading.Tasks.Task

Public Overridable Function WriteLineAsync () As Task

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

ObjectDisposedException

The text writer is disposed.

InvalidOperationException

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

Remarks

The line terminator is defined by the CoreNewLine field.

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().

See also

• WriteLineAsync()

WriteLineAsync(StringBuilder, CancellationToken)

Source:

TextWriter.cs

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

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

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

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

Parameters

value

StringBuilder

The string, as a string builder, to write to the text stream.

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

The line terminator is defined by the CoreNewLine field.

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:

TextWriter.cs

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

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

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

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

Public Overridable Function WriteLineAsync (value As Char) As Task

Parameters

value

Char

The character to write to the text stream.

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

ObjectDisposedException

The text writer is disposed.

InvalidOperationException

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

Remarks

The line terminator is defined by the CoreNewLine field.

The TextWriter class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the WriteLineAsync method, see the StreamWriter.WriteLineAsync method.

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(Char).

See also

• WriteLineAsync(Char)
• WriteLineAsync(Char)