Returns a task that performs an asynchronous request to return a result segment containing a collection of shares whose names begin with the specified prefix.
Assembly: Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)
Syntax
[DoesServiceRequestAttribute] public virtual Task<ShareResultSegment> ListSharesSegmentedAsync( string prefix, ShareListingDetails detailsIncluded, Nullable<int> maxResults, FileContinuationToken currentToken, FileRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken )
public: [DoesServiceRequestAttribute] virtual Task<ShareResultSegment^>^ ListSharesSegmentedAsync( String^ prefix, ShareListingDetails detailsIncluded, Nullable<int> maxResults, FileContinuationToken^ currentToken, FileRequestOptions^ options, OperationContext^ operationContext, CancellationToken cancellationToken )
[<DoesServiceRequestAttribute>] abstract ListSharesSegmentedAsync : prefix:string * detailsIncluded:ShareListingDetails * maxResults:Nullable<int> * currentToken:FileContinuationToken * options:FileRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task<ShareResultSegment> [<DoesServiceRequestAttribute>] override ListSharesSegmentedAsync : prefix:string * detailsIncluded:ShareListingDetails * maxResults:Nullable<int> * currentToken:FileContinuationToken * options:FileRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task<ShareResultSegment>
<DoesServiceRequestAttribute> Public Overridable Function ListSharesSegmentedAsync ( prefix As String, detailsIncluded As ShareListingDetails, maxResults As Nullable(Of Integer), currentToken As FileContinuationToken, options As FileRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken ) As Task(Of ShareResultSegment)
Parameters
- prefix
-
Type:
System.StringSystem::String^System.StringSystem.String
The share name prefix.
- detailsIncluded
-
Type:
Microsoft.WindowsAzure.Storage.File.ShareListingDetailsMicrosoft.WindowsAzure.Storage.File::ShareListingDetailsMicrosoft.WindowsAzure.Storage.File.ShareListingDetailsMicrosoft.WindowsAzure.Storage.File.ShareListingDetails
A value that indicates whether to return share metadata with the listing.
- maxResults
-
Type:
System.Nullable<Int32>System::Nullable<Int32>System.Nullable<Int32>System.Nullable(Of Int32)
A non-negative integer value that indicates the maximum number of results to be returned in the result segment, up to the per-operation limit of 5000. If this value is null, the maximum possible number of results will be returned, up to 5000.
- currentToken
-
Type:
Microsoft.WindowsAzure.Storage.File.FileContinuationTokenMicrosoft.WindowsAzure.Storage.File::FileContinuationToken^Microsoft.WindowsAzure.Storage.File.FileContinuationTokenMicrosoft.WindowsAzure.Storage.File.FileContinuationToken
A continuation token returned by a previous listing operation.
- options
-
Type:
Microsoft.WindowsAzure.Storage.File.FileRequestOptionsMicrosoft.WindowsAzure.Storage.File::FileRequestOptions^Microsoft.WindowsAzure.Storage.File.FileRequestOptionsMicrosoft.WindowsAzure.Storage.File.FileRequestOptions
A FileRequestOptions object that specifies additional options for the request.
- operationContext
-
Type:
Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage::OperationContext^Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage.OperationContext
An OperationContext object that represents the context for the current operation.
- cancellationToken
-
Type:
System.Threading.CancellationTokenSystem.Threading::CancellationTokenSystem.Threading.CancellationTokenSystem.Threading.CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Return Value
Type: System.Threading.Tasks.Task<ShareResultSegment>System.Threading.Tasks::Task<ShareResultSegment^>^System.Threading.Tasks.Task<ShareResultSegment>System.Threading.Tasks.Task(Of ShareResultSegment)A Task<TResult><TResult><'TResult>(Of TResult) object that represents the current operation.
See Also
ListSharesSegmentedAsync Overload
CloudFileClient Class
Microsoft.WindowsAzure.Storage.File Namespace