StreamReader.ReadToEndAsync 方法

定義

命名空間:

System.IO

組件:

System.Runtime.dll

多載

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

ReadToEndAsync()

來源:

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

之前的讀取作業目前正在使用讀取器。

範例

下列範例示範如何使用 方法來讀取檔案 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

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

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

取消標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

如果此方法是透過 cancellationToken取消的，則) 或傳 (回給呼叫端) (已從目前 Stream 讀取但未儲存 (StreamReader 的某些數據可能會遺失。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 ReadToEnd()例外狀況。