GZipStream.WriteAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| WriteAsync(ReadOnlyMemory<Byte>, CancellationToken) |
Asynchronously writes compressed bytes to the underlying GZip stream from the specified read-only byte memory region. |
| WriteAsync(Byte[], Int32, Int32, CancellationToken) |
Asynchronously writes compressed bytes to the underlying GZip stream from the specified byte array. |
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)
- Source:
- GZipStream.cs
- Source:
- GZipStream.cs
- Source:
- GZipStream.cs
Asynchronously writes compressed bytes to the underlying GZip stream from the specified read-only byte memory region.
public override System.Threading.Tasks.ValueTask WriteAsync (ReadOnlyMemory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);override this.WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTaskPublic Overrides Function WriteAsync (buffer As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTaskParameters
- 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 cancellation token was canceled. This exception is stored into the returned task.
Remarks
The WriteAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in desktop apps where a time-consuming stream operation can block the UI thread and make the app appear as if it's not working. The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.
Use the CanWrite property to determine whether the current instance supports writing.
If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property.
Applies to
WriteAsync(Byte[], Int32, Int32, CancellationToken)
- Source:
- GZipStream.cs
- Source:
- GZipStream.cs
- Source:
- GZipStream.cs
Asynchronously writes compressed bytes to the underlying GZip stream from the specified byte array.
public:
override System::Threading::Tasks::Task ^ WriteAsync(cli::array <System::Byte> ^ array, int offset, int count, System::Threading::CancellationToken cancellationToken);public:
override System::Threading::Tasks::Task ^ WriteAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);public override System.Threading.Tasks.Task WriteAsync (byte[] array, int offset, int count, System.Threading.CancellationToken cancellationToken);public override System.Threading.Tasks.Task WriteAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);override this.WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Taskoverride this.WriteAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overrides Function WriteAsync (array As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As TaskPublic Overrides Function WriteAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As TaskParameters
- arraybuffer
- Byte[]
The buffer that contains the data to compress.
- offset
- Int32
The zero-based byte offset from which to begin copying bytes to the GZip 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
The cancellation token was canceled. This exception is stored into the returned task.
Remarks
The WriteAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. This performance consideration is particularly important in desktop apps where a time-consuming stream operation can block the UI thread and make the app appear as if it's not working. The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.
Use the CanWrite property to determine whether the current instance supports writing.
If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.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).
