ShareDirectoryClient.GetHandlesAsync 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 GetHandlesAsync(Nullable<Boolean>, 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(bool? recursive = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetHandlesAsync : Nullable<bool> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Files.Shares.Models.ShareFileHandle>
override this.GetHandlesAsync : Nullable<bool> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Files.Shares.Models.ShareFileHandle>Public Overridable Function GetHandlesAsync (Optional recursive As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ShareFileHandle)Parameters
Optional. A boolean value that specifies if the operation should also apply to the files and subdirectories of the directory specified.
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be cancelled.
Returns
A AsyncPageable<T> describing the handles on the directory.
Remarks
A RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an AggregateException will be thrown, containing each failure instance.
