StringReader.ReadAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| ReadAsync(Char[], Int32, Int32) |
指定した最大文字数を現在の文字列から非同期的に読み取り、バッファーの指定したインデックス位置にそのデータを書き込みます。 |
| ReadAsync(Memory<Char>, CancellationToken) |
非同期的に、入力文字列の現在位置から開始してすべての文字を読み取り、現在位置を入力文字列の末尾に進めます。 |
ReadAsync(Char[], Int32, Int32)
- ソース:
- StringReader.cs
- ソース:
- StringReader.cs
- ソース:
- 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);[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
読み取り対象の最大文字数。 指定された文字数をバッファーに書き込む前に文字列の末尾に到達した場合、メソッドは制御を返します。
戻り値
非同期の読み取り操作を表すタスク。 TResult パラメーターの値には、バッファーに読み込まれるバイトの合計数が含まれます。 現在使用できるバイト数が要求した数より小さい場合、結果の値は要求したバイト数より小さくなることがあります。また、文字列の末尾に到達した場合は 0 になることがあります。
- 属性
例外
buffer が nullです。
index または count が負の値です。
index と count の合計が、バッファーの長さよりも大きいです。
文字列リーダーは破棄されています。
リーダーは、前の読み取り操作によって現在使用されています。
例
次の例は、文字列の最初の 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
- ソース:
- StringReader.cs
- ソース:
- 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)パラメーター
- cancellationToken
- CancellationToken
キャンセル要求を監視するためのトークン。 既定値は None です。
戻り値
非同期の読み取り操作を表すタスク。 TResult パラメーターの値には、バッファーに読み込まれる文字の合計数が含まれます。
例外
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
適用対象
.NET