TextWriter.WriteAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Writes data to the text stream asynchronously.
Overloads
| WriteAsync(Char[], Int32, Int32) |
Writes a subarray of characters to the text stream asynchronously. |
| WriteAsync(StringBuilder, CancellationToken) |
Asynchronously writes a string builder to the text stream. |
| WriteAsync(ReadOnlyMemory<Char>, CancellationToken) |
Asynchronously writes a character memory region to the text stream. |
| WriteAsync(String) |
Writes a string to the text stream asynchronously. |
| WriteAsync(Char[]) |
Writes a character array to the text stream asynchronously. |
| WriteAsync(Char) |
Writes a character to the text stream asynchronously. |
WriteAsync(Char[], Int32, Int32)
Writes a subarray of characters to the text stream asynchronously.
public:
virtual System::Threading::Tasks::Task ^ WriteAsync(cli::array <char> ^ buffer, int index, int count);public virtual System.Threading.Tasks.Task WriteAsync (char[] buffer, int index, int count);[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task WriteAsync (char[] buffer, int index, int count);abstract member WriteAsync : char[] * int * int -> System.Threading.Tasks.Task
override this.WriteAsync : char[] * int * int -> System.Threading.Tasks.Task[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member WriteAsync : char[] * int * int -> System.Threading.Tasks.Task
override this.WriteAsync : char[] * int * int -> System.Threading.Tasks.TaskPublic Overridable Function WriteAsync (buffer As Char(), index As Integer, count As Integer) As TaskParameters
- 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
A task that represents the asynchronous write operation.
- Attributes
Exceptions
buffer is null.
The index plus count is greater than the buffer length.
index or count is negative.
The text writer is disposed.
The text writer is currently in use by a previous write operation.
Remarks
The TextWriter class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the WriteAsync method, see the StreamWriter.WriteAsync method.
See also
Applies to
WriteAsync(StringBuilder, CancellationToken)
Asynchronously writes a string builder to the text stream.
public virtual System.Threading.Tasks.Task WriteAsync (System.Text.StringBuilder? value, System.Threading.CancellationToken cancellationToken = default);abstract member WriteAsync : System.Text.StringBuilder * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.WriteAsync : System.Text.StringBuilder * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function WriteAsync (value As StringBuilder, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- 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
A task that represents the asynchronous write operation.
Remarks
This method is equivalent to calling WriteAsync(stringBuilder.ToString()), however, it uses the StringBuilder.GetChunks() method to avoid creating the intermediate string.
Applies to
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)
Asynchronously writes a character memory region to the text stream.
public virtual System.Threading.Tasks.Task WriteAsync (ReadOnlyMemory<char> buffer, System.Threading.CancellationToken cancellationToken = default);abstract member WriteAsync : ReadOnlyMemory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.WriteAsync : ReadOnlyMemory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function WriteAsync (buffer As ReadOnlyMemory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- 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
A task that represents the asynchronous write operation.
Applies to
WriteAsync(String)
Writes a string to the text stream asynchronously.
public:
virtual System::Threading::Tasks::Task ^ WriteAsync(System::String ^ value);public virtual System.Threading.Tasks.Task WriteAsync (string value);public virtual System.Threading.Tasks.Task WriteAsync (string? value);[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task WriteAsync (string value);abstract member WriteAsync : string -> System.Threading.Tasks.Task
override this.WriteAsync : string -> System.Threading.Tasks.Task[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member WriteAsync : string -> System.Threading.Tasks.Task
override this.WriteAsync : string -> System.Threading.Tasks.TaskPublic Overridable Function WriteAsync (value As String) As TaskParameters
- value
- String
The string to write. If value is null, nothing is written to the text stream.
Returns
A task that represents the asynchronous write operation.
- Attributes
Exceptions
The text writer is disposed.
The text writer is currently in use by a previous write operation.
Remarks
The TextWriter class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the WriteAsync method, see the StreamWriter.WriteAsync method.
See also
Applies to
WriteAsync(Char[])
Writes a character array to the text stream asynchronously.
public:
System::Threading::Tasks::Task ^ WriteAsync(cli::array <char> ^ buffer);public System.Threading.Tasks.Task WriteAsync (char[] buffer);public System.Threading.Tasks.Task WriteAsync (char[]? buffer);[System.Runtime.InteropServices.ComVisible(false)]
public System.Threading.Tasks.Task WriteAsync (char[] buffer);member this.WriteAsync : char[] -> System.Threading.Tasks.Task[<System.Runtime.InteropServices.ComVisible(false)>]
member this.WriteAsync : char[] -> System.Threading.Tasks.TaskPublic Function WriteAsync (buffer As Char()) As TaskParameters
- buffer
- Char[]
The character array to write to the text stream. If buffer is null, nothing is written.
Returns
A task that represents the asynchronous write operation.
- Attributes
Exceptions
The text writer is disposed.
The text writer is currently in use by a previous write operation.
See also
Applies to
WriteAsync(Char)
Writes a character to the text stream asynchronously.
public:
virtual System::Threading::Tasks::Task ^ WriteAsync(char value);public virtual System.Threading.Tasks.Task WriteAsync (char value);[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task WriteAsync (char value);abstract member WriteAsync : char -> System.Threading.Tasks.Task
override this.WriteAsync : char -> System.Threading.Tasks.Task[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member WriteAsync : char -> System.Threading.Tasks.Task
override this.WriteAsync : char -> System.Threading.Tasks.TaskPublic Overridable Function WriteAsync (value As Char) As TaskParameters
- value
- Char
The character to write to the text stream.
Returns
A task that represents the asynchronous write operation.
- Attributes
Exceptions
The text writer is disposed.
The text writer is currently in use by a previous write operation.
Remarks
The TextWriter class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the WriteAsync method, see the StreamWriter.WriteAsync method.