StreamWriter.WriteLineAsync メソッド

定義

名前空間:

System.IO

アセンブリ:

System.Runtime.dll

データを、続いて行終端記号を非同期でストリームに書き込みます。

オーバーロード

WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)	文字メモリ領域のテキスト表現を、続いて行終端記号を非同期でストリームに書き込みます。
WriteLineAsync()	行終端記号をストリームに非同期で書き込みます。
WriteLineAsync(Char)	文字を、続いて行終端記号を非同期でストリームに書き込みます。
WriteLineAsync(String)	文字列を、続いて行終端記号を非同期でストリームに書き込みます。
WriteLineAsync(Char[], Int32, Int32)	文字の部分配列を、続いて行終端記号を非同期でストリームに書き込みます。

WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)

ソース:

StreamWriter.cs

文字メモリ領域のテキスト表現を、続いて行終端記号を非同期でストリームに書き込みます。

public override System.Threading.Tasks.Task WriteLineAsync (ReadOnlyMemory<char> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.WriteLineAsync : ReadOnlyMemory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function WriteLineAsync (buffer As ReadOnlyMemory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

buffer

ReadOnlyMemory<Char>

ストリームに書き込む文字メモリ領域。

cancellationToken

CancellationToken

キャンセル要求を監視するためのトークン。 既定値は None です。

戻り値

Task

非同期の書き込み操作を表すタスク。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

行終端記号は、CoreNewLine フィールドで定義されます。

WriteLineAsync()

ソース:

StreamWriter.cs

行終端記号をストリームに非同期で書き込みます。

public:
 override System::Threading::Tasks::Task ^ WriteLineAsync();

public override System.Threading.Tasks.Task WriteLineAsync ();

override this.WriteLineAsync : unit -> System.Threading.Tasks.Task

Public Overrides Function WriteLineAsync () As Task

戻り値

Task

非同期の書き込み操作を表すタスク。

例外

ObjectDisposedException

ストリーム ライターは破棄されます。

InvalidOperationException

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

注釈

行ターミネータは、 プロパティによって定義されます TextWriter.NewLine 。

WriteLineAsync(Char)

ソース:

StreamWriter.cs

文字を、続いて行終端記号を非同期でストリームに書き込みます。

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

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

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

Public Overrides Function WriteLineAsync (value As Char) As Task

パラメーター

value

Char

ストリームに書き込む文字。

戻り値

Task

非同期の書き込み操作を表すタスク。

例外

ObjectDisposedException

ストリーム ライターは破棄されます。

InvalidOperationException

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

例

次の例では、 メソッドを使用して、テキスト ファイル内の行に 1 文字 (文字 "a") を書き込み、その後に 1 つの文字 (文字 "b") を含む別の行を書き込む方法を WriteLineAsync(Char) 示します。

using System.IO;

namespace ConsoleApplication
{
    class Program3
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteLineAsync('a');
                await writer.WriteLineAsync('b');
            }
        }
    }
}

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        WriteCharacters()
    End Sub

    Async Sub WriteCharacters()
        Dim firstChar As Char = "a"
        Dim secondChar As Char = "b"
        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteLineAsync(firstChar)
            Await writer.WriteLineAsync(secondChar)
        End Using
    End Sub
End Module

注釈

行ターミネータは、 プロパティによって定義されます TextWriter.NewLine 。

WriteLineAsync(String)

ソース:

StreamWriter.cs

文字列を、続いて行終端記号を非同期でストリームに書き込みます。

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

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

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

Public Overrides Function WriteLineAsync (value As String) As Task

パラメーター

value

String

書き込む文字列。 値が null の場合は、行終端記号だけが書き込まれます。

戻り値

Task

非同期の書き込み操作を表すタスク。

例外

ObjectDisposedException

ストリーム ライターは破棄されます。

InvalidOperationException

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

例

次の例は、 メソッドを使用して文字列値で構成される 2 行をテキスト ファイルに書き込む方法を WriteLineAsync(String) 示しています。

using System.IO;

namespace ConsoleApplication
{
    class Program4
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteLineAsync("First line of example");
                await writer.WriteLineAsync("and second line");
            }
        }
    }
}

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.WriteLineAsync("First line of example")
            Await writer.WriteLineAsync("and second line")
        End Using
    End Sub
End Module

注釈

行ターミネータは、 プロパティによって定義されます TextWriter.NewLine 。

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって WriteLine(String)スローされる例外に関するページを参照してください。

WriteLineAsync(Char[], Int32, Int32)

ソース:

StreamWriter.cs

文字の部分配列を、続いて行終端記号を非同期でストリームに書き込みます。

public:
 override System::Threading::Tasks::Task ^ WriteLineAsync(cli::array <char> ^ buffer, int index, int count);

public override System.Threading.Tasks.Task WriteLineAsync (char[] buffer, int index, int count);

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

Public Overrides Function WriteLineAsync (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

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

例

次の例では、 メソッドを使用してテキスト ファイル内の 2 行に文字を書き込む方法を WriteLineAsync(Char[], Int32, Int32) 示します。 最初の行には、文字列の最初の 11 文字が含まれます (文字 "First line" の後にスペースが続きます)。 2 行目には、文字列の残りの文字 (文字 "および 2 行目") が含まれています。

using System.IO;
using System.Text;

namespace ConsoleApplication
{
    class Program6
    {
        static void Main()
        {
            WriteCharacters();
        }

        static async void WriteCharacters()
        {
            UnicodeEncoding ue = new UnicodeEncoding();
            char[] charsToAdd = ue.GetChars(ue.GetBytes("First line and second line"));
            using (StreamWriter writer = File.CreateText("newfile.txt"))
            {
                await writer.WriteLineAsync(charsToAdd, 0, 11);
                await writer.WriteLineAsync(charsToAdd, 11, charsToAdd.Length - 11);
            }
        }
    }
}

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("First line and second line"))

        Using writer As StreamWriter = File.CreateText("newfile.txt")
            Await writer.WriteLineAsync(charsToAdd, 0, 11)
            Await writer.WriteLineAsync(charsToAdd, 11, charsToAdd.Length - 11)
        End Using
    End Sub
End Module

注釈

行ターミネータは、 プロパティによって定義されます TextWriter.NewLine 。