ShareDirectoryClient.GetHandles Method

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Package:

Azure.Storage.Files.Shares v12.21.0

Source:

ShareDirectoryClient.cs

The GetHandles(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.Pageable<Azure.Storage.Files.Shares.Models.ShareFileHandle> GetHandles (bool? recursive = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetHandles : Nullable<bool> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Files.Shares.Models.ShareFileHandle>
override this.GetHandles : Nullable<bool> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Files.Shares.Models.ShareFileHandle>

Public Overridable Function GetHandles (Optional recursive As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ShareFileHandle)

Parameters

recursive

Nullable<Boolean>

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

Pageable<ShareFileHandle>

An IEnumerable<T> of Response<T> describing the handles in the directory.

Remarks

A RequestFailedException will be thrown if a failure occurs.