ShareFileClient.GetHandles(CancellationToken) Method

Reference

Definition

Namespace:: Azure.Storage.Files.Shares

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

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

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

Source:: ShareFileClient.cs

Source:: ShareFileClient.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 GetHandles(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 (System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetHandles (Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ShareFileHandle)

Parameters

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.

Applies to