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)
[<ComVisibleAttribute(false)>] [<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)>] abstract CopyToAsync : destination:Stream * bufferSize:int * cancellationToken:CancellationToken -> Task [<ComVisibleAttribute(false)>] [<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)>] override CopyToAsync : destination:Stream * bufferSize:int * cancellationToken:CancellationToken -> Task
- 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 81920.
Return ValueType: System.Threading.Tasks.Task
A task that represents the asynchronous copy operation.
destination is a null reference (Nothing in Visual Basic).
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 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.
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.