StreamReader.ReadToEndAsync メソッド

定義

オーバーロード

ReadToEndAsync()

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

ReadToEndAsync(CancellationToken)

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

ReadToEndAsync()

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

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

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

戻り値

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

属性

例外

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

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

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

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

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

注釈

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

適用対象

ReadToEndAsync(CancellationToken)

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

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

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync(System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<string> ReadToEndAsync (System.Threading.CancellationToken cancellationToken);
override this.ReadToEndAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
Public Overrides Function ReadToEndAsync (cancellationToken As CancellationToken) As Task(Of String)

パラメーター

cancellationToken
CancellationToken

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

戻り値

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

例外

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

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

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

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

注釈

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

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

適用対象