DeflateStream.DisposeAsync Method

Definition

Namespace:

System.IO.Compression

Assembly:

System.IO.Compression.dll

Source:

DeflateStream.cs

Asynchronously releases the unmanaged resources used by the DeflateStream.

public:
 override System::Threading::Tasks::ValueTask DisposeAsync();

public override System.Threading.Tasks.ValueTask DisposeAsync ();

override this.DisposeAsync : unit -> System.Threading.Tasks.ValueTask

Public Overrides Function DisposeAsync () As ValueTask

Returns

ValueTask

A task that represents the asynchronous dispose operation.

Remarks

The DisposeAsync method enables you to perform a resource-intensive dispose operation 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#.

This method disposes the Deflate stream by writing any changes to the backing store and closing the stream to release resources.

Calling DisposeAsync allows the resources used by the DeflateStream to be reallocated for other purposes. For more information, see Cleaning Up Unmanaged Resources.