Stream.CopyToAsync Method (Stream, Int32, CancellationToken)
July 28, 2014
Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.
Assembly: mscorlib (in mscorlib.dll)
public virtual Task CopyToAsync( Stream destination, int bufferSize, CancellationToken cancellationToken )
- Type: System.IO.Stream
The stream to which the contents of the current stream will be copied.
- Type: System.Int32
The size, in bytes, of the buffer. This value must be greater than zero. The default size is 4096.
Return ValueType: System.Threading.Tasks.Task
A task that represents the asynchronous copy operation.
destination is null.
buffersize is negative or zero.
Either the current stream or the destination stream is disposed.
The current stream does not support reading, or the destination stream does not support writing.
The CopyToAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in a Windows Windows Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.
Copying begins at the current position in the current stream.
For an example of copying between two streams, see the CopyToAsync overload.