TextWriter.WriteAsync 方法

定义

将数据异步写入文本流。

重载

WriteAsync(Char[], Int32, Int32)

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

WriteAsync(StringBuilder, CancellationToken)

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

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

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

WriteAsync(String)

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

WriteAsync(Char[])

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

WriteAsync(Char)

将字符异步写入文本流。

WriteAsync(Char[], Int32, Int32)

Source:
TextWriter.cs
Source:
TextWriter.cs
Source:
TextWriter.cs

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

C#
public virtual System.Threading.Tasks.Task WriteAsync (char[] buffer, int index, int count);
C#
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task WriteAsync (char[] buffer, int index, int count);

参数

buffer
Char[]

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

index
Int32

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

count
Int32

要写入的字符数。

返回

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

属性

例外

buffernull

indexcount 大于缓冲区长度。

indexcount 为负数。

文本编写器已被释放。

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

注解

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

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

另请参阅

适用于

.NET 9 和其他版本
产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

WriteAsync(StringBuilder, CancellationToken)

Source:
TextWriter.cs
Source:
TextWriter.cs
Source:
TextWriter.cs

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

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

参数

value
StringBuilder

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

cancellationToken
CancellationToken

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

返回

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

例外

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

注解

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

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

适用于

.NET 9 和其他版本
产品 版本
.NET Core 3.0, Core 3.1, 5, 6, 7, 8, 9

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

Source:
TextWriter.cs
Source:
TextWriter.cs
Source:
TextWriter.cs

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

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

参数

buffer
ReadOnlyMemory<Char>

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

cancellationToken
CancellationToken

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

返回

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

例外

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

适用于

.NET 9 和其他版本
产品 版本
.NET Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Standard 2.1

WriteAsync(String)

Source:
TextWriter.cs
Source:
TextWriter.cs
Source:
TextWriter.cs

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

C#
public virtual System.Threading.Tasks.Task WriteAsync (string value);
C#
public virtual System.Threading.Tasks.Task WriteAsync (string? value);
C#
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task WriteAsync (string value);

参数

value
String

要写入的字符串。 如果 valuenull,则不会将任何内容写入文本流。

返回

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

属性

例外

文本编写器已被释放。

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

注解

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

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

另请参阅

适用于

.NET 9 和其他版本
产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

WriteAsync(Char[])

Source:
TextWriter.cs
Source:
TextWriter.cs
Source:
TextWriter.cs

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

C#
public System.Threading.Tasks.Task WriteAsync (char[] buffer);
C#
public System.Threading.Tasks.Task WriteAsync (char[]? buffer);
C#
[System.Runtime.InteropServices.ComVisible(false)]
public System.Threading.Tasks.Task WriteAsync (char[] buffer);

参数

buffer
Char[]

要写入文本流中的字符数组。 如果 buffernull,则不写入任何内容。

返回

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

属性

例外

文本编写器已被释放。

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

注解

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

另请参阅

适用于

.NET 9 和其他版本
产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

WriteAsync(Char)

Source:
TextWriter.cs
Source:
TextWriter.cs
Source:
TextWriter.cs

将字符异步写入文本流。

C#
public virtual System.Threading.Tasks.Task WriteAsync (char value);
C#
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task WriteAsync (char value);

参数

value
Char

要写入文本流中的字符。

返回

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

属性

例外

文本编写器已被释放。

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

注解

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

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

另请参阅

适用于

.NET 9 和其他版本
产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0