StringWriter.WriteAsync 方法

參考

定義

命名空間:: System.IO

組件:: System.IO.dll

組件:: System.Runtime.dll

組件:: System.Runtime.Extensions.dll

組件:: mscorlib.dll

組件:: netstandard.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

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

多載

WriteAsync(Char)	以非同步方式將字元寫入字串。
WriteAsync(String)	將字串以非同步方式寫入目前的字串。
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	以非同步方式將字元的記憶體區域寫入字串。
WriteAsync(StringBuilder, CancellationToken)	以非同步方式將字串產生器的文字表示寫入字串。
WriteAsync(Char[], Int32, Int32)	以非同步方式將字元的子陣列寫入字串。

WriteAsync(Char)

來源:: StringWriter.cs

來源:: StringWriter.cs

來源:: StringWriter.cs

以非同步方式將字元寫入字串。

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

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

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

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

[<System.Runtime.InteropServices.ComVisible(false)>]
override this.WriteAsync : char -> System.Threading.Tasks.Task

Public Overrides Function WriteAsync (value As Char) As Task

參數

value: Char

要寫入字串的字元。

傳回

Task

表示非同步寫入作業的工作。

屬性: ComVisibleAttribute

例外狀況

ObjectDisposedException

字串寫入器已經處置。

InvalidOperationException

字串寫入器目前正由先前的寫入作業所使用。

範例

下列範例示範如何使用方法來撰寫字元 WriteAsync(Char) 。

using System;
using System.Text;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            StringBuilder stringToWrite = new StringBuilder("Characters in StringBuilder");
            stringToWrite.AppendLine();

            using (StringWriter writer = new StringWriter(stringToWrite))
            {
                UnicodeEncoding ue = new UnicodeEncoding();
                char[] charsToAdd = ue.GetChars(ue.GetBytes("and chars to add"));
                foreach (char c in charsToAdd)
                {
                    await writer.WriteAsync(c);
                }
                Console.WriteLine(stringToWrite.ToString());
            }
        }
    }
}
// The example displays the following output:
//
// Characters in StringBuilder
// and chars to add
//

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim stringToWrite As StringBuilder = New StringBuilder("Characters in StringBuilder")
        stringToWrite.AppendLine()

        Using writer As StringWriter = New StringWriter(stringToWrite)

            Dim ue As UnicodeEncoding = New UnicodeEncoding()
            Dim charsToAdd() = ue.GetChars(ue.GetBytes("and chars to add"))
            For Each c As Char In charsToAdd
                Await writer.WriteAsync(c)
            Next
            Console.WriteLine(stringToWrite.ToString())
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in StringBuilder
' and chars to add
'

備註

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用狀況例外狀況。如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。使用狀況例外狀況，例如 ArgumentException，仍會同步擲回。如需預存的例外狀況，請參閱所 Write(Char)擲回的例外狀況。

適用於

WriteAsync(String)

來源:: StringWriter.cs

來源:: StringWriter.cs

來源:: StringWriter.cs

將字串以非同步方式寫入目前的字串。

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

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

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

[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task WriteAsync (string value);

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

[<System.Runtime.InteropServices.ComVisible(false)>]
override this.WriteAsync : string -> System.Threading.Tasks.Task

Public Overrides Function WriteAsync (value As String) As Task

參數

value: String

要寫入的字串。如果 value 為 null，不寫入任何字串到文字資料流。

傳回

Task

表示非同步寫入作業的工作。

屬性: ComVisibleAttribute

例外狀況

ObjectDisposedException

字串寫入器已經處置。

InvalidOperationException

字串寫入器目前正由先前的寫入作業所使用。

範例

下列範例示範如何使用方法來撰寫字串 WriteAsync(String) 。

using System;
using System.Text;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            StringBuilder stringToWrite = new StringBuilder("Characters in StringBuilder");
            stringToWrite.AppendLine();

            using (StringWriter writer = new StringWriter(stringToWrite))
            {
                await writer.WriteAsync("and add characters through StringWriter");
                Console.WriteLine(stringToWrite.ToString());
            }
        }
    }
}
// The example displays the following output:
//
// Characters in StringBuilder
// and add characters through StringWriter
//

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim stringToWrite As StringBuilder = New StringBuilder("Characters in StringBuilder")
        stringToWrite.AppendLine()

        Using writer As StringWriter = New StringWriter(stringToWrite)
            Await writer.WriteAsync("and add characters through StringWriter")
            Console.WriteLine(stringToWrite.ToString())
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in StringBuilder
' and add characters through StringWriter
'

備註

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用狀況例外狀況。如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。使用狀況例外狀況，例如 ArgumentException，仍會同步擲回。如需預存的例外狀況，請參閱所 Write(String)擲回的例外狀況。

適用於

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

來源:: StringWriter.cs

來源:: StringWriter.cs

來源:: StringWriter.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(StringBuilder, CancellationToken)

來源:: StringWriter.cs

來源:: StringWriter.cs

來源:: StringWriter.cs

以非同步方式將字串產生器的文字表示寫入字串。

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

override this.WriteAsync : System.Text.StringBuilder * System.Threading.CancellationToken -> System.Threading.Tasks.Task

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

參數

value: StringBuilder

要寫入字串的字串產生器。

cancellationToken: CancellationToken

用來監視是否有取消要求的語彙基元。預設值是 None。

傳回

Task

表示非同步寫入作業的工作。

例外狀況

OperationCanceledException

取消令牌已取消。此例外狀況會儲存在傳回的工作中。

備註

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用狀況例外狀況。如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。使用狀況例外狀況，例如 ArgumentException，仍會同步擲回。如需預存的例外狀況，請參閱所 Write(StringBuilder)擲回的例外狀況。

適用於

WriteAsync(Char[], Int32, Int32)

來源:: StringWriter.cs

來源:: StringWriter.cs

來源:: StringWriter.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);

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

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

[<System.Runtime.InteropServices.ComVisible(false)>]
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

表示非同步寫入作業的工作。

屬性: ComVisibleAttribute

例外狀況

ArgumentNullException

buffer 為 null。

ArgumentException

index 加上 count 大於緩衝區長度。

ArgumentOutOfRangeException

index 或 count 為負。

ObjectDisposedException

字串寫入器已經處置。

InvalidOperationException

字串寫入器目前正由先前的寫入作業所使用。

範例

下列範例示範如何使用方法來撰寫字元 WriteAsync(Char[], Int32, Int32) 。

using System;
using System.Text;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            StringBuilder stringToWrite = new StringBuilder("Characters in StringBuilder");
            stringToWrite.AppendLine();

            using (StringWriter writer = new StringWriter(stringToWrite))
            {
                UnicodeEncoding ue = new UnicodeEncoding();
                char[] charsToAdd = ue.GetChars(ue.GetBytes("and chars to add"));

                await writer.WriteAsync(charsToAdd, 0, charsToAdd.Length);

                Console.WriteLine(stringToWrite.ToString());
            }
        }
    }
}
// The example displays the following output:
//
// Characters in StringBuilder
// and chars to add
//

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim stringToWrite As StringBuilder = New StringBuilder("Characters in StringBuilder")
        stringToWrite.AppendLine()

        Using writer As StringWriter = New StringWriter(stringToWrite)

            Dim ue As UnicodeEncoding = New UnicodeEncoding()
            Dim charsToAdd() = ue.GetChars(ue.GetBytes("and chars to add"))

            Await writer.WriteAsync(charsToAdd, 0, charsToAdd.Length)

            Console.WriteLine(stringToWrite.ToString())
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in StringBuilder
' and chars to add
'

備註

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用狀況例外狀況。如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。使用狀況例外狀況，例如 ArgumentException，仍會同步擲回。如需預存的例外狀況，請參閱所 Write(Char[], Int32, Int32)擲回的例外狀況。

適用於

共用方式為

StringWriter.WriteAsync 方法

定義

多載

WriteAsync(Char)

參數

傳回

例外狀況

範例

備註

適用於

WriteAsync(String)

參數

傳回

例外狀況

範例

備註

適用於

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

參數

傳回

例外狀況

適用於

WriteAsync(StringBuilder, CancellationToken)

參數

傳回

例外狀況

備註

適用於

WriteAsync(Char[], Int32, Int32)

參數

傳回

例外狀況

範例

備註

適用於

其他資源