StreamWriter.WriteAsync メソッド

定義

名前空間:: System.IO

アセンブリ:: mscorlib.dll, System.IO.dll

アセンブリ:: mscorlib.dll

アセンブリ:: System.IO.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ストリームにデータを非同期に書き込みます。

オーバーロード

名前	説明
WriteAsync(Char[], Int32, Int32)	文字のサブ配列をストリームに非同期的に書き込みます。
WriteAsync(ReadOnlyMemory<Char>, CancellationToken)	文字メモリ領域をストリームに非同期的に書き込みます。
WriteAsync(Char)	ストリームに文字を非同期に書き込みます。
WriteAsync(String)	ストリームに文字列を非同期に書き込みます。

WriteAsync(Char[], Int32, Int32)

文字のサブ配列をストリームに非同期的に書き込みます。

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)によってスローされる例外を参照してください。

適用対象

WriteAsync(ReadOnlyMemory<Char>, CancellationToken)

文字メモリ領域をストリームに非同期的に書き込みます。

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)

ストリームに文字を非同期に書き込みます。

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) メソッドを使用して 1 文字 (文字 "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)

ストリームに文字列を非同期に書き込みます。

public:
 override System::Threading::Tasks::Task ^ WriteAsync(System::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)によってスローされる例外を参照してください。

適用対象

フィードバック

このページはお役に立ちましたか?