Export (0) Print
Expand All

MemoryStream::WriteAsync Method (array<Byte>, Int32, Int32, CancellationToken)

.NET Framework 4.5

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)

[ComVisibleAttribute(false)]
[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
public:
virtual Task^ WriteAsync(
	array<unsigned char>^ buffer, 
	int offset, 
	int count, 
	CancellationToken cancellationToken
) override

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.

ExceptionCondition
ArgumentNullException

buffer is nullptr.

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.

NoteNote

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.

.NET Framework

Supported in: 4.5

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft