MemoryStream.WriteAsync Method (array<Byte>[]()[], Int32, Int32, CancellationToken)

Article
11/23/2015

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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)

Syntax

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

public override Task WriteAsync(
    byte[] buffer,
    int offset,
    int count,
    CancellationToken cancellationToken
)

Parameters

buffer
Type: array<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.

Exceptions

Exception	Condition
ArgumentNullException	buffer is nullNothingnullptra null reference (Nothing in Visual Basic).
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.

Remarks

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.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0