StreamReader.ReadLineAsync メソッド

定義

名前空間:

System.IO

アセンブリ:

System.Runtime.dll

オーバーロード

ReadLineAsync()	現在のストリームから非同期的に 1 行分の文字を読み取り、そのデータを文字列として返します。
ReadLineAsync(CancellationToken)	現在のストリームから非同期的に 1 行分の文字を読み取り、そのデータを文字列として返します。

ReadLineAsync()

現在のストリームから非同期的に 1 行分の文字を読み取り、そのデータを文字列として返します。

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadLineAsync();

public override System.Threading.Tasks.Task<string?> ReadLineAsync ();

override this.ReadLineAsync : unit -> System.Threading.Tasks.Task<string>

Public Overrides Function ReadLineAsync () As Task(Of String)

戻り値

Task<String>

非同期の読み取り操作を表すタスク。 TResult パラメーターの値には、ストリームの次の行が含まれます。または、すべての文字が読み取られた場合は null です。

例外

ArgumentOutOfRangeException

次の行の文字数が Int32.MaxValue を超えています。

ObjectDisposedException

ストリームは破棄されています。

InvalidOperationException

リーダーは、前の読み取り操作によって現在使用されています。

例

次の例は、 メソッドを使用してファイルの最初の行を読み取る方法を ReadLineAsync() 示しています。

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static async Task Main()
        {
            await ReadCharacters();
        }

        static async Task ReadCharacters()
        {
            String result;
            using (StreamReader reader = File.OpenText("existingfile.txt"))
            {
                Console.WriteLine("Opened file.");
                result = await reader.ReadLineAsync();
                Console.WriteLine("First line contains: " + result);
            }
        }
    }
}

Imports System.IO

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim result As String

        Using reader As StreamReader = File.OpenText("existingfile.txt")
            Console.WriteLine("Opened file.")
            result = Await reader.ReadLineAsync()
            Console.WriteLine("First line contains: " + result)
        End Using
    End Sub
End Module

注釈

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

ReadLineAsync(CancellationToken)

現在のストリームから非同期的に 1 行分の文字を読み取り、そのデータを文字列として返します。

public:
 override System::Threading::Tasks::ValueTask<System::String ^> ReadLineAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.ValueTask<string?> ReadLineAsync (System.Threading.CancellationToken cancellationToken);

override this.ReadLineAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<string>

Public Overrides Function ReadLineAsync (cancellationToken As CancellationToken) As ValueTask(Of String)

パラメーター

cancellationToken

CancellationToken

キャンセル要求を監視するためのトークン。

戻り値

ValueTask<String>

非同期の読み取り操作を表す値タスク。 パラメーターの TResult 値にはストリームの次の行が含まれます。または、すべての文字が読み取られた場合は です null 。

例外

ArgumentOutOfRangeException

次の行の文字数が Int32.MaxValue を超えています。

ObjectDisposedException

ストリーム リーダーが破棄されました。

InvalidOperationException

リーダーは、前の読み取り操作によって現在使用されています。

OperationCanceledException

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

注釈

このメソッドが を介して cancellationToken取り消されると、現在 Stream の から読み取られたが、(によって StreamReader) 格納されていないデータや(呼び出し元に) 返されたデータが失われる可能性があります。

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