StreamExtensions.CopyToAsync Method (Stream, Stream, Int32)

StreamExtensionsCopyToAsync Method (Stream, Stream, Int32)

Asynchronously reads the bytes from a source stream and writes them to a destination stream, using a specified buffer size.

Namespace: Rackspace.Threading
Assembly: Rackspace.Threading (in Rackspace.Threading.dll) Version: 2.1.0-beta1

Syntax

public static Task CopyToAsync(
	this Stream stream,
	Stream destination,
	int bufferSize
)

<ExtensionAttribute>
Public Shared Function CopyToAsync ( 
	stream As Stream,
	destination As Stream,
	bufferSize As Integer
) As Task

public:
[ExtensionAttribute]
static Task^ CopyToAsync(
	Stream^ stream, 
	Stream^ destination, 
	int bufferSize
)

[<ExtensionAttribute>]
static member CopyToAsync : 
        stream : Stream * 
        destination : Stream * 
        bufferSize : int -> Task

stream: Type: System.IOStream
The source stream.
destination: Type: System.IOStream
The stream to which the contents of the source stream will be copied.
bufferSize: Type: SystemInt32
The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920.

Type: Task
A task that represents the asynchronous copy operation.

In Visual Basic and C#, you can call this method as an instance method on any object of type Stream. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	If stream is . -or- If destination is .
ArgumentOutOfRangeException	If bufferSize is negative or zero.
ObjectDisposedException	If stream is disposed. -or- If destination is disposed.
NotSupportedException	If stream does not support reading. -or- If destination does not support writing.

Remarks

Copying begins at the current position in stream.

Version Information

Supported in: Windows 8

Supported in: 4.5, 4.0, 3.5

Supported in: Portable Class Library (Legacy), Portable Class Library

Supported in: 2.1, 2.0, 1.1, 1.0