StringReader.ReadToEndAsync メソッド

定義

名前空間:

System.IO

アセンブリ:

System.Runtime.dll

オーバーロード

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

ReadToEndAsync()

ソース:

StringReader.cs

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

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync();

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

override this.ReadToEndAsync : unit -> System.Threading.Tasks.Task<string>

Public Overrides Function ReadToEndAsync () As Task(Of String)

戻り値

Task<String>

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

例外

ArgumentOutOfRangeException

文字数が Int32.MaxValue を超えています。

ObjectDisposedException

文字列リーダーは破棄されています。

InvalidOperationException

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

例

次の例は、文字列全体を非同期的に読み取る方法を示しています。

using System;
using System.IO;
using System.Text;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            ReadCharacters();
        }

        static async void ReadCharacters()
        {
            StringBuilder stringToRead = new StringBuilder();
            stringToRead.AppendLine("Characters in 1st line to read");
            stringToRead.AppendLine("and 2nd line");
            stringToRead.AppendLine("and the end");

            using (StringReader reader = new StringReader(stringToRead.ToString()))
            {
                string readText = await reader.ReadToEndAsync();
                Console.WriteLine(readText);
            }
        }
    }
}
// The example displays the following output:
//
// Characters in 1st line to read
// and 2nd line
// and the end
//

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim stringToRead = New StringBuilder()
        stringToRead.AppendLine("Characters in 1st line to read")
        stringToRead.AppendLine("and 2nd line")
        stringToRead.AppendLine("and the end")

        Using reader As StringReader = New StringReader(stringToRead.ToString())
            Dim readText As String = Await reader.ReadToEndAsync()
            Console.WriteLine(readText)
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in 1st line to read
' and 2nd line
' and the end
'

注釈

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

ReadToEndAsync(CancellationToken)

ソース:

StringReader.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

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

戻り値

Task<String>

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

例外

ArgumentOutOfRangeException

文字数が Int32.MaxValue を超えています。

ObjectDisposedException

文字列リーダーは破棄されています。

InvalidOperationException

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

OperationCanceledException

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

注釈

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