Stream.DisposeAsync 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.
Asynchronously releases the unmanaged resources used by the Stream.
public:
virtual System::Threading::Tasks::ValueTask DisposeAsync();public virtual System.Threading.Tasks.ValueTask DisposeAsync ();abstract member DisposeAsync : unit -> System.Threading.Tasks.ValueTask
override this.DisposeAsync : unit -> System.Threading.Tasks.ValueTaskPublic Overridable Function DisposeAsync () As ValueTaskReturns
A task that represents the asynchronous dispose operation.
Implements
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 a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.
This method disposes the stream by writing any changes to the backing store and closing the stream to release resources.
Calling DisposeAsync allows the resources used by the Stream to be reallocated for other purposes. For more information, see Cleaning Up Unmanaged Resources.
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 Dispose().
