MemoryStream.WriteAsync Method (Byte(), Int32, Int32, CancellationToken)

May 11, 2014

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
Public Overrides Function WriteAsync ( _
	buffer As Byte(), _
	offset As Integer, _
	count As Integer, _
	cancellationToken As CancellationToken _
) As Task

Parameters

buffer
Type: System.Byte ()
The buffer to write data from.
offset
Type: System.Int32
The zero-based byte offset in buffer from which to begin copying bytes to the stream.
count
Type: System.Int32
The maximum number of bytes to write.
cancellationToken
Type: System.Threading.CancellationToken
The token to monitor for cancellation requests. The default value is None.

Return Value

Type: System.Threading.Tasks.Task
A task that represents the asynchronous write operation.

ExceptionCondition
ArgumentNullException

buffer is Nothing.

ArgumentOutOfRangeException

offset or count is negative.

ArgumentException

The sum of offset and count is larger than the buffer length.

NotSupportedException

The stream does not support writing.

ObjectDisposedException

The stream has been disposed.

InvalidOperationException

The stream is currently in use by a previous write operation.

If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

You can create a cancellation token by creating an instance of the CancellationTokenSource class and passing the Token property as the cancellationToken parameter.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2014 Microsoft