FileStream.CopyToAsync(Stream, Int32, CancellationToken) 方法

定义

命名空间:

System.IO

程序集:

System.Runtime.dll

Source:

FileStream.cs

使用指定的缓冲区大小和取消令牌，从当前文件流中异步读取字节并将其写入到另一个流中。

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

缓冲区的大小（以字节为单位）。 此值必须大于零。 默认大小为 81920。

cancellationToken

CancellationToken

要监视取消请求的标记。 默认值为 None。

返回

Task

表示异步复制操作的任务。

例外

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

使用 CopyToAsync 方法可以执行资源密集型 I/O 操作，而不会阻止main线程。 在 Windows 8.x 应用商店应用或桌面应用中一个耗时的流操作可能阻塞 UI 线程并让应用看起来好像不工作时，这种性能的考虑就显得尤为重要了。 异步方法与 async Visual Basic 和 C# 中的 和 await 关键字结合使用。

如果在操作完成之前取消了操作，则返回的任务将包含 TaskStatus.Canceled 属性的值 Task.Status 。

复制从当前文件流中的当前位置开始。

有关在两个流之间复制的示例，请参阅 CopyToAsync(Stream) 重载。