StreamReader.ReadToEndAsync メソッド

定義

名前空間:

System.IO

アセンブリ:

System.Runtime.dll

オーバーロード

ReadToEndAsync()	現在位置からストリームの末尾まですべての文字を非同期的に読み取り、1 つの文字列として返します。
ReadToEndAsync(CancellationToken)	現在位置からストリームの末尾まですべての文字を非同期的に読み取り、1 つの文字列として返します。

ReadToEndAsync()

ソース:

StreamReader.cs

現在位置からストリームの末尾まですべての文字を非同期的に読み取り、1 つの文字列として返します。

C#

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

戻り値

Task<String>

非同期の読み取り操作を表すタスク。 TResult パラメーターの値には、現在位置からストリームの末尾までの文字から成る文字列が含まれます。

例外

ArgumentOutOfRangeException

文字数が Int32.MaxValue より大きい。

ObjectDisposedException

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

InvalidOperationException

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

例

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

C#

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.ReadToEndAsync();
                Console.WriteLine("Contains: " + result);
            }
        }
    }
}

注釈

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

ReadToEndAsync(CancellationToken)

ソース:

StreamReader.cs

現在位置からストリームの末尾まですべての文字を非同期的に読み取り、1 つの文字列として返します。

C#

public override System.Threading.Tasks.Task<string> ReadToEndAsync (System.Threading.CancellationToken cancellationToken);

パラメーター

cancellationToken

CancellationToken

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

戻り値

Task<String>

非同期の読み取り操作を表すタスク。 TResult パラメーターの値には、現在位置からストリームの末尾までの文字から成る文字列が含まれます。

例外

ArgumentOutOfRangeException

文字数が Int32.MaxValue より大きい。

ObjectDisposedException

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

InvalidOperationException

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

OperationCanceledException

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

注釈

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

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