CryptoStream.WriteAsync Method

Definition

Overloads

WriteAsync(Byte[], Int32, Int32, CancellationToken)

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

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

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.

WriteAsync(Byte[], Int32, Int32, CancellationToken)

Source:
CryptoStream.cs
Source:
CryptoStream.cs
Source:
CryptoStream.cs

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

C#
public override System.Threading.Tasks.Task WriteAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

Parameters

buffer
Byte[]

The buffer to write data from.

offset
Int32

The zero-based byte offset in buffer from which to begin writing bytes to the stream.

count
Int32

The maximum number of bytes to write.

cancellationToken
CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

A task that represents the asynchronous write operation.

Exceptions

buffer is null.

offset or count is negative.

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

The stream does not support writing.

The stream has been disposed.

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

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

You must preface your call to WriteAsync with the await (C#) or Await (Visual Basic) operator to suspend execution of the method until the task is complete. For more information, see Asynchronous programming (C#) or Asynchronous programming with Async and Await (Visual Basic).

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

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Write(Byte[], Int32, Int32).

See also

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Source:
CryptoStream.cs
Source:
CryptoStream.cs
Source:
CryptoStream.cs

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.

C#
public override System.Threading.Tasks.ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

Parameters

buffer
ReadOnlyMemory<Byte>

The region of memory to write data from.

cancellationToken
CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

A task that represents the asynchronous write operation.

Exceptions

The CryptoStreamMode associated with current CryptoStream object does not match the underlying stream. For example, this exception is thrown when using Write with an underlying stream that is read only.

The cancellation token was canceled. This exception is stored into the returned task.

Applies to

.NET 9 and other versions
Product Versions
.NET 6, 7, 8, 9