TextWriter.WriteAsync 方法

定义

命名空间:

System.IO

程序集:

System.Runtime.dll

将数据异步写入文本流。

重载

WriteAsync(Char[], Int32, Int32)	以异步形式将字符的子数组写入文本流。
WriteAsync(StringBuilder, CancellationToken)	以异步形式将字符串生成器写入文本流。
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	以异步形式将字符内存区域写入文本流。
WriteAsync(String)	将字符串异步写入文本流。
WriteAsync(Char[])	将字符数组异步写入文本流。
WriteAsync(Char)	将字符异步写入文本流。

WriteAsync(Char[], Int32, Int32)

Source:

TextWriter.cs

以异步形式将字符的子数组写入文本流。

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);

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

Public Overridable Function WriteAsync (buffer As Char(), index As Integer, count As Integer) As Task

参数

buffer

Char[]

要从中写出数据的字符数组。

index

Int32

在开始接收数据时缓存中的字符位置。

count

Int32

要写入的字符数。

返回

Task

表示异步写入操作的任务。

例外

ArgumentNullException

buffer 为 null。

ArgumentException

index 加 count 大于缓冲区长度。

ArgumentOutOfRangeException

index 或 count 为负数。

ObjectDisposedException

文本编写器已被释放。

InvalidOperationException

文本编写器正在由其前一次写操作使用。

注解

类是一个抽象类。 因此，不要在代码中实例化它。 有关使用 WriteAsync 方法的示例，请参阅 StreamWriter.WriteAsync 方法。

此方法将存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中，则在等待任务时将引发该异常。 使用异常（如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅 引发的 Write(Char[], Int32, Int32)异常。

另请参阅

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

WriteAsync(StringBuilder, CancellationToken)

Source:

TextWriter.cs

以异步形式将字符串生成器写入文本流。

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.Task

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

参数

value

StringBuilder

要作为字符串生成器写入文本流的字符串。

cancellationToken

CancellationToken

要监视取消请求的标记。 默认值为 None。

返回

Task

表示异步写入操作的任务。

例外

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

此方法等效于调用 WriteAsync(stringBuilder.ToString())，但是，它使用 StringBuilder.GetChunks() 方法来避免创建中间字符串。

此方法将存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中，则在等待任务时将引发该异常。 使用异常（如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅 引发的 Write(StringBuilder)异常。

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

Source:

TextWriter.cs

以异步形式将字符内存区域写入文本流。

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.Task

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

参数

buffer

ReadOnlyMemory<Char>

要写入文本流中的字符内存区域。

cancellationToken

CancellationToken

要监视取消请求的标记。 默认值为 None。

返回

Task

表示异步写入操作的任务。

例外

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

WriteAsync(String)

Source:

TextWriter.cs

将字符串异步写入文本流。

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

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

Public Overridable Function WriteAsync (value As String) As Task

参数

value

String

要写入的字符串。 如果 value 为 null，则不会将任何内容写入文本流。

返回

Task

表示异步写入操作的任务。

例外

ObjectDisposedException

文本编写器已被释放。

InvalidOperationException

文本编写器正在由其前一次写操作使用。

注解

类是一个抽象类。 因此，不要在代码中实例化它。 有关使用 WriteAsync 方法的示例，请参阅 StreamWriter.WriteAsync 方法。

此方法将存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中，则在等待任务时将引发该异常。 使用异常（如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅 引发的 Write(String)异常。

另请参阅

• WriteAsync(String)
• WriteAsync(String)

WriteAsync(Char[])

Source:

TextWriter.cs

将字符数组异步写入文本流。

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

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

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

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

参数

buffer

Char[]

要写入文本流中的字符数组。 如果 buffer 为 null，则不写入任何内容。

返回

Task

表示异步写入操作的任务。

例外

ObjectDisposedException

文本编写器已被释放。

InvalidOperationException

文本编写器正在由其前一次写操作使用。

注解

此方法将存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中，则在等待任务时将引发该异常。 使用异常（如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅 引发的 Write(Char[])异常。

另请参阅

• StreamWriter
• StringWriter

WriteAsync(Char)

Source:

TextWriter.cs

将字符异步写入文本流。

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

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

Public Overridable Function WriteAsync (value As Char) As Task

参数

value

Char

要写入文本流中的字符。

返回

Task

表示异步写入操作的任务。

例外

ObjectDisposedException

文本编写器已被释放。

InvalidOperationException

文本编写器正在由其前一次写操作使用。

注解

类是一个抽象类。 因此，不要在代码中实例化它。 有关使用 WriteAsync 方法的示例，请参阅 StreamWriter.WriteAsync 方法。

此方法将存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中，则在等待任务时将引发该异常。 使用异常（如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅 引发的 Write(Char)异常。

另请参阅

• WriteAsync(Char)
• WriteAsync(Char)