File.ReadLinesAsync メソッド

定義

オーバーロード

ReadLinesAsync(String, CancellationToken)

ファイルの行を非同期的に読み取ります。

ReadLinesAsync(String, Encoding, CancellationToken)

指定したエンコーディングを持つファイルの行を非同期的に読み取ります。

ReadLinesAsync(String, CancellationToken)

ソース:
File.cs
ソース:
File.cs
ソース:
File.cs

ファイルの行を非同期的に読み取ります。

public static System.Collections.Generic.IAsyncEnumerable<string> ReadLinesAsync (string path, System.Threading.CancellationToken cancellationToken = default);
static member ReadLinesAsync : string * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<string>
Public Shared Function ReadLinesAsync (path As String, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of String)

パラメーター

path
String

読み取るファイル。

cancellationToken
CancellationToken

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

戻り値

ファイルのすべての行、またはクエリの結果である行を表す非同期列挙可能。

例外

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

注釈

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

適用対象

ReadLinesAsync(String, Encoding, CancellationToken)

ソース:
File.cs
ソース:
File.cs
ソース:
File.cs

指定したエンコーディングを持つファイルの行を非同期的に読み取ります。

public static System.Collections.Generic.IAsyncEnumerable<string> ReadLinesAsync (string path, System.Text.Encoding encoding, System.Threading.CancellationToken cancellationToken = default);
static member ReadLinesAsync : string * System.Text.Encoding * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<string>
Public Shared Function ReadLinesAsync (path As String, encoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of String)

パラメーター

path
String

読み取るファイル。

encoding
Encoding

ファイルの内容に適用されるエンコーディング。

cancellationToken
CancellationToken

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

戻り値

ファイルのすべての行、またはクエリの結果である行を表す非同期列挙可能。

例外

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

注釈

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

適用対象