StringReader.ReadLineAsync メソッド

定義

名前空間:

System.IO

アセンブリ:

System.Runtime.dll

オーバーロード

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

ReadLineAsync()

ソース:

StringReader.cs

現在の文字列から非同期的に 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

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

例

次の例は、文字列から一度に 1 行ずつ非同期的に読み取る方法を示しています。

using System;
using System.IO;
using System.Text;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            ReadCharacters();
        }

        static async void ReadCharacters()
        {
            StringBuilder stringToRead = new StringBuilder();
            stringToRead.AppendLine("Characters in 1st line to read");
            stringToRead.AppendLine("and 2nd line");
            stringToRead.AppendLine("and the end");

            string readText;

            using (StringReader reader = new StringReader(stringToRead.ToString()))
            {
                while ((readText = await reader.ReadLineAsync()) != null)
                {
                    Console.WriteLine(readText);
                }
            }
        }
    }
}
// The example displays the following output:
//
// Characters in 1st line to read
// and 2nd line
// and the end
//

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim stringToRead = New StringBuilder()
        stringToRead.AppendLine("Characters in 1st line to read")
        stringToRead.AppendLine("and 2nd line")
        stringToRead.AppendLine("and the end")

        Using reader As StringReader = New StringReader(stringToRead.ToString())
            Dim readText As String = Await reader.ReadLineAsync()
            While Not IsNothing(readText)
                Console.WriteLine(readText)
                readText = Await reader.ReadLineAsync()
            End While
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in 1st line to read
' and 2nd line
' and the end
'

注釈

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

ReadLineAsync(CancellationToken)

ソース:

StringReader.cs

現在の文字列から非同期的に 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

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

注釈

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