ShareDirectoryClient.DeleteIfExistsAsync(CancellationToken) Method

Reference

Definition

Namespace:: Azure.Storage.Files.Shares

Assembly:: Azure.Storage.Files.Shares.dll

Package:: Azure.Storage.Files.Shares v12.20.1

Package:: Azure.Storage.Files.Shares v12.21.0-beta.2

Source:: ShareDirectoryClient.cs

Source:: ShareDirectoryClient.cs

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.

The DeleteIfExistsAsync(CancellationToken) operation removes the specified empty directory, if it exists.

For more information, see Delete Directory.

public virtual System.Threading.Tasks.Task<Azure.Response<bool>> DeleteIfExistsAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteIfExistsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.DeleteIfExistsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>

Public Overridable Function DeleteIfExistsAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))

Parameters

cancellationToken: CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Task<Response<Boolean>>

True if the directory existed.

Remarks

Note that the directory must be empty before it can be deleted.

Applies to

Share via