ShareFileClient.DeleteIfExistsAsync 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.
The DeleteIfExists(ShareFileRequestConditions, CancellationToken) operation immediately removes the file from the storage account, if it exists.
For more information, see Delete File.
public virtual System.Threading.Tasks.Task<Azure.Response<bool>> DeleteIfExistsAsync(Azure.Storage.Files.Shares.Models.ShareFileRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteIfExistsAsync : Azure.Storage.Files.Shares.Models.ShareFileRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.DeleteIfExistsAsync : Azure.Storage.Files.Shares.Models.ShareFileRequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>Public Overridable Function DeleteIfExistsAsync (Optional conditions As ShareFileRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))Parameters
- conditions
- ShareFileRequestConditions
Optional ShareFileRequestConditions to add conditions on creating the file.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be cancelled.
Returns
True if the file existed.
Remarks
A RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an AggregateException will be thrown, containing each failure instance.
