StringReader.ReadToEndAsync 方法

定義

命名空間:

System.IO

組件:

System.Runtime.dll

多載

ReadToEndAsync()	非同步讀取從目前位置到字串末端的所有字元，並將它們以單一字串傳回。
ReadToEndAsync(CancellationToken)	非同步讀取從目前位置到字串末端的所有字元，並將它們以單一字串傳回。

ReadToEndAsync()

來源:

StringReader.cs

非同步讀取從目前位置到字串末端的所有字元，並將它們以單一字串傳回。

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

非同步讀取從目前位置到字串末端的所有字元，並將它們以單一字串傳回。

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()例外狀況。