StreamReader.ReadToEndAsync メソッド

定義

現在位置からストリームの末尾まですべての文字を非同期的に読み取り、1 つの文字列として返します。Reads all characters from the current position to the end of the stream asynchronously and returns them as one string.

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)

戻り値

Task<String>

非同期の読み取り操作を表すタスク。A task that represents the asynchronous read operation. TResult パラメーターの値には、現在位置からストリームの末尾までの文字から成る文字列が含まれます。The value of the TResult parameter contains a string with the characters from the current position to the end of the stream.

属性

例外

文字数が MaxValue を超えています。The number of characters is larger than MaxValue.

ストリームは破棄されています。The stream has been disposed.

リーダーは、前の読み取り操作によって現在使用されています。The reader is currently in use by a previous read operation.

次の例は、メソッドを使用してファイルの内容を読み取る方法を示して ReadToEndAsync() います。The following example shows how to read the contents of a file by using the ReadToEndAsync() method.

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

適用対象