CloudQueueClient.BeginListQueuesSegmented Method (String, QueueListingDetails, Int32, QueueContinuationToken, QueueRequestOptions, OperationContext, AsyncCallback, Object)

Article
04/30/2013
2 minutes to read

Begins an asynchronous operation to return a result segment containing a collection of queue items.

Namespace: Microsoft.WindowsAzure.Storage.Queue
Assembly: Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)

Usage

'Usage
Dim instance As CloudQueueClient
Dim prefix As String
Dim blobListingDetails As QueueListingDetails
Dim maxResults As Integer
Dim currentToken As QueueContinuationToken
Dim options As QueueRequestOptions
Dim operationContext As OperationContext
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As ICancellableAsyncResult

returnValue = instance.BeginListQueuesSegmented(prefix, blobListingDetails, maxResults, currentToken, options, operationContext, callback, state)

Syntax

'Declaration
Public Function BeginListQueuesSegmented ( _
    prefix As String, _
    blobListingDetails As QueueListingDetails, _
    maxResults As Integer, _
    currentToken As QueueContinuationToken, _
    options As QueueRequestOptions, _
    operationContext As OperationContext, _
    callback As AsyncCallback, _
    state As Object _
) As ICancellableAsyncResult

public ICancellableAsyncResult BeginListQueuesSegmented (
    string prefix,
    QueueListingDetails blobListingDetails,
    int maxResults,
    QueueContinuationToken currentToken,
    QueueRequestOptions options,
    OperationContext operationContext,
    AsyncCallback callback,
    Object state
)

public:
ICancellableAsyncResult^ BeginListQueuesSegmented (
    String^ prefix, 
    QueueListingDetails blobListingDetails, 
    int maxResults, 
    QueueContinuationToken^ currentToken, 
    QueueRequestOptions^ options, 
    OperationContext^ operationContext, 
    AsyncCallback^ callback, 
    Object^ state
)

public ICancellableAsyncResult BeginListQueuesSegmented (
    String prefix, 
    QueueListingDetails blobListingDetails, 
    int maxResults, 
    QueueContinuationToken currentToken, 
    QueueRequestOptions options, 
    OperationContext operationContext, 
    AsyncCallback callback, 
    Object state
)

public function BeginListQueuesSegmented (
    prefix : String, 
    blobListingDetails : QueueListingDetails, 
    maxResults : int, 
    currentToken : QueueContinuationToken, 
    options : QueueRequestOptions, 
    operationContext : OperationContext, 
    callback : AsyncCallback, 
    state : Object
) : ICancellableAsyncResult

Parameters

prefix
The queue name prefix.

blobListingDetails
A QueueListingDetails enumeration describing which items to include in the listing.

maxResults
A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is zero, the maximum possible number of results will be returned, up to 5000.

currentToken
A QueueContinuationToken returned by a previous listing operation.

options
An object that specifies any additional options for the request.

operationContext
An OperationContext object that represents the context for the current operation. This object is used to track requests, and to provide additional runtime information about the operation.

callback
The callback delegate that will receive notification when the asynchronous operation completes.

state
A user-defined object that will be passed to the callback delegate.

Return Value

An ICancellableAsyncResult that references the asynchronous operation.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7 and Windows Server 2008