StreamWriter.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(Char[], Int32, Int32)	文字の部分配列をストリームに非同期で書き込みます。

WriteAsync(Char)

ソース:: StreamWriter.cs

ソース:: StreamWriter.cs

ソース:: StreamWriter.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

ストリームライターは現在、前の書き込み操作で使用中です。

例

次の例は、メソッドを使用してテキストファイルに 1 文字 (文字 "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

ソース:: StreamWriter.cs

ソース:: StreamWriter.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.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

ソース:: StreamWriter.cs

ソース:: 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

ソース:: StreamWriter.cs

ソース:: 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);

[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.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)スローされる例外に関するページを参照してください。

適用対象

次の方法で共有

StreamWriter.WriteAsync メソッド

定義

オーバーロード

WriteAsync(Char)

パラメーター

戻り値

例外

例

注釈

適用対象

WriteAsync(String)

パラメーター

戻り値

例外

例

注釈

適用対象

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

パラメーター

戻り値

例外

適用対象

WriteAsync(Char[], Int32, Int32)

パラメーター

戻り値

例外

例

注釈

適用対象

その他のリソース