Begins 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 ICancellableAsyncResult BeginListSharesSegmented( string prefix, ShareListingDetails detailsIncluded, Nullable<int> maxResults, FileContinuationToken currentToken, FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state )
public: [DoesServiceRequestAttribute] virtual ICancellableAsyncResult^ BeginListSharesSegmented( String^ prefix, ShareListingDetails detailsIncluded, Nullable<int> maxResults, FileContinuationToken^ currentToken, FileRequestOptions^ options, OperationContext^ operationContext, AsyncCallback^ callback, Object^ state )
[<DoesServiceRequestAttribute>] abstract BeginListSharesSegmented : prefix:string * detailsIncluded:ShareListingDetails * maxResults:Nullable<int> * currentToken:FileContinuationToken * options:FileRequestOptions * operationContext:OperationContext * callback:AsyncCallback * state:Object -> ICancellableAsyncResult [<DoesServiceRequestAttribute>] override BeginListSharesSegmented : prefix:string * detailsIncluded:ShareListingDetails * maxResults:Nullable<int> * currentToken:FileContinuationToken * options:FileRequestOptions * operationContext:OperationContext * callback:AsyncCallback * state:Object -> ICancellableAsyncResult
<DoesServiceRequestAttribute> Public Overridable Function BeginListSharesSegmented ( prefix As String, detailsIncluded As ShareListingDetails, maxResults As Nullable(Of Integer), currentToken As FileContinuationToken, options As FileRequestOptions, operationContext As OperationContext, callback As AsyncCallback, state As Object ) As ICancellableAsyncResult
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.
- callback
-
Type:
System.AsyncCallbackSystem::AsyncCallback^System.AsyncCallbackSystem.AsyncCallback
The callback delegate that will receive notification when the asynchronous operation completes.
- state
-
Type:
System.ObjectSystem::Object^System.ObjectSystem.Object
A user-defined object that will be passed to the callback delegate.
Return Value
Type: Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage::ICancellableAsyncResult^Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage.ICancellableAsyncResultAn IAsyncResult that references the asynchronous operation.
See Also
BeginListSharesSegmented Overload
CloudFileClient Class
Microsoft.WindowsAzure.Storage.File Namespace