MemoryStream.ReadAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| 名前 | 説明 |
|---|---|
| ReadAsync(Memory<Byte>, CancellationToken) |
現在のメモリ ストリームからバイト シーケンスを非同期に読み取り、シーケンスを |
| ReadAsync(Byte[], Int32, Int32, CancellationToken) |
現在のストリームからバイト シーケンスを非同期に読み取り、読み取ったバイト数だけストリーム内の位置を進め、取り消し要求を監視します。 |
ReadAsync(Memory<Byte>, CancellationToken)
現在のメモリ ストリームからバイト シーケンスを非同期に読み取り、シーケンスを destinationに書き込み、読み取ったバイト数だけメモリ ストリーム内の位置を進め、キャンセル要求を監視します。
public override System.Threading.Tasks.ValueTask<int> ReadAsync(Memory<byte> destination, System.Threading.CancellationToken cancellationToken = default);override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>Public Overrides Function ReadAsync (destination As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)パラメーター
- cancellationToken
- CancellationToken
キャンセル要求を監視するトークン。 既定値は None です。
返品
非同期読み取り操作を表すタスク。
Result プロパティの値には、destinationに読み込まれる合計バイト数が含まれます。 結果の値は、現在使用できないバイト数が destination に割り当てられたバイト数より小さい場合があります。また、メモリ ストリームの末尾に達した場合は 0 (ゼロ) にすることができます。
例外
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
適用対象
ReadAsync(Byte[], Int32, Int32, CancellationToken)
現在のストリームからバイト シーケンスを非同期に読み取り、読み取ったバイト数だけストリーム内の位置を進め、取り消し要求を監視します。
public:
override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);public override System.Threading.Tasks.Task<int> ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)パラメーター
- buffer
- Byte[]
データを書き込むバッファー。
- offset
- Int32
ストリームからのデータの書き込みを開始する buffer のバイト オフセット。
- count
- Int32
読み取る最大バイト数。
- cancellationToken
- CancellationToken
キャンセル要求を監視するトークン。 既定値は None です。
返品
非同期読み取り操作を表すタスク。
TResult パラメーターの値には、バッファーに読み込まれる合計バイト数が含まれます。 現在使用可能なバイト数が要求された数より少ない場合は、結果の値が要求されたバイト数より小さい場合、またはストリームの末尾に達した場合は 0 (ゼロ) にすることができます。
- 属性
例外
buffer は nullです。
offset または count が負の値です。
offsetとcountの合計がバッファー長を超えています。
ストリームは読み取りをサポートしていません。
ストリームが破棄されました。
ストリームは現在、以前の読み取り操作で使用されています。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
操作が完了する前に取り消された場合、返されるタスクには、Canceled プロパティのStatus値が含まれます。
キャンセル トークンを作成するには、 CancellationTokenSource クラスのインスタンスを作成し、 Token プロパティを cancellationToken パラメーターとして渡します。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Read(Byte[], Int32, Int32)によってスローされる例外を参照してください。