StringReader.ReadAsync メソッド

定義

名前空間:
System.IO
アセンブリ:
netstandard.dll
アセンブリ:
mscorlib.dll, System.IO.dll
アセンブリ:
mscorlib.dll
アセンブリ:
System.IO.dll

オーバーロード

名前 説明
ReadAsync(Memory<Char>, CancellationToken)

入力文字列から現在位置からすべての文字を非同期に読み取り、現在位置を入力文字列の末尾に進めます。
ReadAsync(Char[], Int32, Int32)

現在の文字列から指定した最大文字数を非同期的に読み取り、指定したインデックスから始まるデータをバッファーに書き込みます。

ReadAsync(Memory<Char>, CancellationToken)

入力文字列から現在位置からすべての文字を非同期に読み取り、現在位置を入力文字列の末尾に進めます。

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

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

適用対象

ReadAsync(Char[], Int32, Int32)

現在の文字列から指定した最大文字数を非同期的に読み取り、指定したインデックスから始まるデータをバッファーに書き込みます。

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);
[System.Runtime.InteropServices.ComVisible(false)]
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>
[<System.Runtime.InteropServices.ComVisible(false)>]
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 (ゼロ) にすることができます。

属性
ComVisibleAttribute

例外

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)によってスローされる例外を参照してください。

適用対象