StringReader.ReadAsync 方法

定義

命名空間:

System.IO

組件:

System.Runtime.dll

多載

ReadAsync(Char[], Int32, Int32)	從目前的字串非同步讀取指定的取大字元數目，並從指定的索引開始將資料寫入緩衝區。
ReadAsync(Memory<Char>, CancellationToken)	從目前位置開始，以非同步方式讀取輸入字串中的所有字元，並將目前位置往前移至輸入字串的結尾。

ReadAsync(Char[], Int32, Int32)

來源:

StringReader.cs

從目前的字串非同步讀取指定的取大字元數目，並從指定的索引開始將資料寫入緩衝區。

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);

public override System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);

override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

參數

buffer

Char[]

當這個方法傳回時，會包含指定的字元陣列，這個陣列具有介於 index 到 (index + count - 1) 之間的值，已由讀取自目前來源的字元所取代。

index

Int32

buffer 中要開始寫入的位置。

count

Int32

要讀取的字元數上限。 如果指定的字元數寫入緩衝區之前，便到達字串末端，則方法會返回。

傳回

Task<Int32>

表示非同步讀取作業的工作。 TResult 參數的值會包含讀取至緩衝區的位元組總數。 如果目前可供使用的位元組數目少於所要求的數目，結果值可能會小於所要求的位元組數目，或者如果已經到達字串末端，則可能為 0（零）。

例外狀況

ArgumentNullException

buffer 為 null。

ArgumentOutOfRangeException

index 或 count 為負。

ArgumentException

index 和 count 的總和大於緩衝區長度。

ObjectDisposedException

字串讀取器已處置。

InvalidOperationException

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

範例

下列範例示範如何以異步方式讀取字串的前 23 個字元。

using System;
using System.IO;

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

        static async void ReadCharacters()
        {
            string stringToRead = "Some characters to read but not all";
            char[] charsRead = new char[stringToRead.Length];

            using (StringReader reader = new StringReader(stringToRead))
            {
                await reader.ReadAsync(charsRead, 0, 23);
                Console.WriteLine(charsRead);
            }
        }
    }
}
// The example displays the following output:
// Some characters to read
//

Imports System.IO

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim stringToRead = "Some characters to read but not all"
        Dim charsRead(stringToRead.Length) As Char

        Using reader As StringReader = New StringReader(stringToRead)
            Await reader.ReadAsync(charsRead, 0, 23)
            Console.WriteLine(charsRead)
        End Using
    End Sub

End Module
' The example displays the following output:
' Some characters to read
'

備註

工作會在讀取 參數指定的 count 字元數或到達字串結尾之後完成。

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

ReadAsync(Memory<Char>, CancellationToken)

來源:

StringReader.cs

從目前位置開始，以非同步方式讀取輸入字串中的所有字元，並將目前位置往前移至輸入字串的結尾。

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

參數

buffer

Memory<Char>

當這個方法傳回時，會包含讀取自目前來源的字元。

cancellationToken

CancellationToken

用來監視是否有取消要求的語彙基元。 預設值是 None。

傳回

ValueTask<Int32>

表示非同步讀取作業的工作。 TResult 參數的值會包含讀入緩衝區的字元總數。

例外狀況

OperationCanceledException

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