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)

パラメーター

戻り値

例外

例

注釈

適用対象

フィードバック

その他のリソース