CloudFileDirectory.ListHandlesSegmentedAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Storage.File
Assembly:
Microsoft.Azure.Storage.File.dll
Package:
Microsoft.Azure.Storage.File v11.2.3

Returns a task that performs an asynchronous operation to get the SMB handles open on this directory.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.FileHandleResultSegment> ListHandlesSegmentedAsync (Microsoft.Azure.Storage.File.FileContinuationToken token = default, int? maxResults = default, bool? recursive = default, Microsoft.Azure.Storage.AccessCondition accessCondition = default, Microsoft.Azure.Storage.File.FileRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default, System.Threading.CancellationToken? cancellationToken = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListHandlesSegmentedAsync : Microsoft.Azure.Storage.File.FileContinuationToken * Nullable<int> * Nullable<bool> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * Nullable<System.Threading.CancellationToken> -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.FileHandleResultSegment>
override this.ListHandlesSegmentedAsync : Microsoft.Azure.Storage.File.FileContinuationToken * Nullable<int> * Nullable<bool> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * Nullable<System.Threading.CancellationToken> -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.FileHandleResultSegment>
Public Overridable Function ListHandlesSegmentedAsync (Optional token As FileContinuationToken = Nothing, Optional maxResults As Nullable(Of Integer) = Nothing, Optional recursive As Nullable(Of Boolean) = Nothing, Optional accessCondition As AccessCondition = Nothing, Optional options As FileRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing, Optional cancellationToken As Nullable(Of CancellationToken) = Nothing) As Task(Of FileHandleResultSegment)

Parameters

token
FileContinuationToken

Continuation token for paginated results.

maxResults
Nullable<Int32>

The maximum number of results to be returned by the server.

recursive
Nullable<Boolean>

Whether to recurse through this directory's files and subfolders. A lack of value is interpreted as false.

accessCondition
AccessCondition

An AccessCondition object that represents the access conditions for the file. If null, no condition is used.

options
FileRequestOptions

A FileRequestOptions object that specifies additional options for the request.

operationContext
OperationContext

An OperationContext object that represents the context for the current operation.

cancellationToken
Nullable<CancellationToken>

A CancellationToken to observe while waiting for a task to complete.

Returns

Task<FileHandleResultSegment>

A Task<TResult> object that represents the current operation.

Attributes
DoesServiceRequestAttribute

Applies to