StreamWriter.WriteAsync 方法

定义

命名空间:

System.IO

程序集:

System.Runtime.dll

将数据异步写入该流。

重载

WriteAsync(Char)	将字符异步写入该流。
WriteAsync(String)	将字符串异步写入该流。
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	将字符内存区域异步写入该流。
WriteAsync(Char[], Int32, Int32)	将字符的子数组异步写入该流。

WriteAsync(Char)

Source:

StreamWriter.cs

将字符异步写入该流。

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

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

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

Public Overrides Function WriteAsync (value As Char) As Task

参数

value

Char

要写入流中的字符。

返回

Task

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

例外

ObjectDisposedException

流编写器已被释放。

InvalidOperationException

流编写器正在由其前一次写入操作使用。

示例

以下示例演示如何使用 WriteAsync(Char) 方法将字母“a”) (单个字符写入文本文件。

using System.IO;

namespace ConsoleApplication
{
    class Program1
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteAsync('a');
            }
        }
    }
}

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim oneLetter As Char = "a"
        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteAsync(oneLetter)
        End Using
    End Sub
End Module

注解

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

WriteAsync(String)

Source:

StreamWriter.cs

将字符串异步写入该流。

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

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

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

Public Overrides Function WriteAsync (value As String) As Task

参数

value

String

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

返回

Task

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

例外

ObjectDisposedException

流编写器已被释放。

InvalidOperationException

流编写器正在由其前一次写入操作使用。

示例

以下示例演示如何使用 WriteAsync(String) 方法将字符串写入文本文件。

using System.IO;

namespace ConsoleApplication
{
    class Program2
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteAsync("Example text as string");
            }
        }
    }
}

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()

        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteAsync("Example text as string")
        End Using
    End Sub
End Module

注解

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

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

Source:

StreamWriter.cs

将字符内存区域异步写入该流。

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

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

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

参数

buffer

ReadOnlyMemory<Char>

要写入流的字符存储区域。

cancellationToken

CancellationToken

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

返回

Task

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

例外

OperationCanceledException

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

WriteAsync(Char[], Int32, Int32)

Source:

StreamWriter.cs

将字符的子数组异步写入该流。

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

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

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

Public Overrides 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(Char[], Int32, Int32) 方法将多个字符写入文本文件。

using System.IO;
using System.Text;

namespace ConsoleApplication
{
    class Program5
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            UnicodeEncoding ue = new UnicodeEncoding();
            char[] charsToAdd = ue.GetChars(ue.GetBytes("Example string"));
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteAsync(charsToAdd, 0, charsToAdd.Length);
            }
        }
    }
}

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim ue As UnicodeEncoding = New UnicodeEncoding()
        Dim charsToAdd() = ue.GetChars(ue.GetBytes("Example string"))

        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteAsync(charsToAdd, 0, charsToAdd.Length)
        End Using
    End Sub
End Module

注解

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