StreamWriter.WriteAsync 方法

定義

命名空間:

System.IO

組件:

System.Runtime.dll

以非同步方式將資料寫入資料流。

多載

WriteAsync(Char)	以非同步方式將字元寫入至資料流。
WriteAsync(String)	以非同步方式將字串寫入資料流。
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	以非同步方式將字元記憶體區域寫入資料流。
WriteAsync(Char[], Int32, Int32)	以非同步方式將字元的子陣列寫入資料流。

WriteAsync(Char)

來源:

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

資料流寫入器目前由先前寫入作業所使用。

範例

下列範例示範如何使用 方法，將單一字元 (字母 “a”) 寫入文本檔 WriteAsync(Char) 。

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)

來源:

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)

來源:

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)

來源:

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)例外狀況。