ZLibStream.CopyToAsync(Stream, Int32, CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.
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.TaskPublic Overrides Function CopyToAsync (destination As Stream, bufferSize As Integer, cancellationToken As CancellationToken) As TaskParameters
- destination
- Stream
The stream to which the contents of the current stream will be copied.
- bufferSize
- Int32
The size, in bytes, of the buffer. This value must be greater than zero.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests.
Returns
A task that represents the asynchronous copy operation.
Exceptions
destination is null.
bufferSize is not a positive number.
The stream does not support reading or writing.
The stream is closed.
Only one asynchronous reader or writer is allowed at a time.
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by CopyTo(Stream, Int32).
