StreamExtensionsWriteAsync Method (Stream, Byte, Int32, Int32, CancellationToken) |
Asynchronously writes a sequence of bytes to a stream, advances the position within the stream by the number of bytes written,
and monitors cancellation requests.
Namespace: Rackspace.ThreadingAssembly: Rackspace.Threading (in Rackspace.Threading.dll) Version: 1.1.0.0
Syntax
public static Task WriteAsync(
this Stream stream,
byte[] buffer,
int offset,
int count,
CancellationToken cancellationToken
)
<ExtensionAttribute>
Public Shared Function WriteAsync (
stream As Stream,
buffer As Byte(),
offset As Integer,
count As Integer,
cancellationToken As CancellationToken
) As Task
public:
[ExtensionAttribute]
static Task^ WriteAsync(
Stream^ stream,
array<unsigned char>^ buffer,
int offset,
int count,
CancellationToken cancellationToken
)
[<ExtensionAttribute>]
static member WriteAsync :
stream : Stream *
buffer : byte[] *
offset : int *
count : int *
cancellationToken : CancellationToken -> Task
Parameters
- stream
- Type: System.IOStream
The stream to write data to. - buffer
- Type: SystemByte
The buffer to read the data from. - offset
- Type: SystemInt32
The zero-based byte offset in buffer from which to begin copying bytes to the stream. - count
- Type: SystemInt32
The maximum number of bytes to write. - cancellationToken
- Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests. The default value is None.
Return Value
Type:
Task
A task that represents the asynchronous write operation.
Usage Note
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
Remarks
Use the
CanWrite property to determine whether the stream instance supports writing.
If the operation is canceled before it completes, the returned task contains the Canceled
value for the Status property.
Version Information
.NET Framework
Supported in: 4.0, 3.5
Portable Class Library
Supported in: Portable Class Library (Legacy)
Rackspace Threading Library
Supported in: 1.1, 1.0
See Also