StreamReader.ReadLineAsync メソッド

定義

名前空間:
System.IO
アセンブリ:
mscorlib.dll, System.IO.dll
アセンブリ:
netstandard.dll, System.Runtime.dll
アセンブリ:
System.IO.dll
アセンブリ:
System.Runtime.Extensions.dll
アセンブリ:
mscorlib.dll
アセンブリ:
netstandard.dll

オーバーロード

名前 説明
ReadLineAsync()

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

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

ReadLineAsync()

ソース:
StreamReader.cs
ソース:
StreamReader.cs
ソース:
StreamReader.cs
ソース:
StreamReader.cs
ソース:
StreamReader.cs

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

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadLineAsync();
public override System.Threading.Tasks.Task<string> ReadLineAsync();
public override System.Threading.Tasks.Task<string?> ReadLineAsync();
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<string> ReadLineAsync();
override this.ReadLineAsync : unit -> System.Threading.Tasks.Task<string>
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadLineAsync : unit -> System.Threading.Tasks.Task<string>
Public Overrides Function ReadLineAsync () As Task(Of String)

返品

Task<String>

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

属性
ComVisibleAttribute

例外

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)

ソース:
StreamReader.cs
ソース:
StreamReader.cs
ソース:
StreamReader.cs
ソース:
StreamReader.cs
ソース:
StreamReader.cs

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

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

適用対象