ShareFileClient.GetHandlesAsync(CancellationToken) Method

Definition

The GetHandlesAsync(CancellationToken) operation returns an async sequence of the open handles on a directory or a file. Enumerating the handles may make multiple requests to the service while fetching all the values.

For more information, see List Handles.

public virtual Azure.AsyncPageable<Azure.Storage.Files.Shares.Models.ShareFileHandle> GetHandlesAsync (System.Threading.CancellationToken cancellationToken = default);
abstract member GetHandlesAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Files.Shares.Models.ShareFileHandle>
override this.GetHandlesAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Files.Shares.Models.ShareFileHandle>
Public Overridable Function GetHandlesAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ShareFileHandle)

Parameters

cancellationToken
CancellationToken

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

Returns

A AsyncPageable<T> describing the handles on the file.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to