Stream::CopyToAsync Method (Stream^, Int32, CancellationToken)
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: [ComVisibleAttribute(false)] [HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)] virtual Task^ CopyToAsync( Stream^ destination, int bufferSize, CancellationToken cancellationToken )
The stream to which the contents of the current stream will be copied.
The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920.
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.
Themethod enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in a Windows 8.x 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(Stream^) overload.
Available since 8
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Available since 8.1