FileStream.CopyToAsync(Stream, Int32, CancellationToken) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定されたバッファー サイズとキャンセル トークンを使用して、バイトの現在のファイル ストリームからの読み取りと、別のストリームへの書き込みを非同期に行います。
public:
override System::Threading::Tasks::Task ^ CopyToAsync(System::IO::Stream ^ destination, int bufferSize, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task CopyToAsync (System.IO.Stream destination, int bufferSize, System.Threading.CancellationToken cancellationToken);
override this.CopyToAsync : System.IO.Stream * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overrides Function CopyToAsync (destination As Stream, bufferSize As Integer, cancellationToken As CancellationToken) As Task
パラメーター
- destination
- Stream
現在のファイル ストリームの内容のコピー先となるストリーム。
- bufferSize
- Int32
バッファーのサイズ (バイト数)。 これは、0 より大きい値である必要があります。 既定のサイズは 81920 です。
- cancellationToken
- CancellationToken
キャンセル要求を監視するためのトークン。 既定値は None です。
戻り値
非同期のコピー操作を表すタスク。
例外
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
CopyToAsync
メソッドを使用すると、メイン スレッドをブロックすることなく、リソースを大量に消費する I/O 操作を実行できます。 このパフォーマンスに関する考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないと見なされる可能性がある Windows 8.x Store アプリまたはデスクトップ アプリで特に重要です。 非同期メソッドは、Visual Basic および C# の および await
キーワードと組み合わせてasync
使用されます。
操作が完了する前に取り消された場合、返されるタスクには プロパティの値がTaskStatus.CanceledTask.Status含まれます。
コピーは、現在のファイル ストリーム内の現在の位置から開始されます。
2 つのストリーム間でコピーする例については、 オーバーロードに関するページを CopyToAsync(Stream) 参照してください。
適用対象
.NET