SALES: 1-800-867-1380
This topic has not yet been rated - Rate this topic

CloudQueueClient.BeginListQueuesSegmented Method (String, QueueListingDetails, Int32, ResultContinuation, AsyncCallback, Object)

Updated: April 24, 2013

[This topic is part of the Windows Azure Storage Client Library 1.7, which has been deprecated. The current recommended version is Storage Client Library 3.0.]

Begins an asynchronous operation to return a result segment containing a collection of queues whose names begin with the specified prefix. Use this overload when you want to control the maximum number of results returned at a time, and when you want to use a continuation token to determine whether there are still more results to return from the service after the current page completes.

Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)
'Usage

public IAsyncResult BeginListQueuesSegmented (
	string prefix,
	QueueListingDetails detailsIncluded,
	int maxResults,
	ResultContinuation continuationToken,
	AsyncCallback callback,
	Object state
)

Parameters

prefix

Type: System.String

The queue name prefix.

detailsIncluded

Type: Microsoft.WindowsAzure.StorageClient.QueueListingDetails

One of the enumeration values that indicates which details to include in the listing.

maxResults

Type: System.Int32

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.

continuationToken

Type: Microsoft.WindowsAzure.StorageClient.ResultContinuation

A continuation token returned by a previous listing operation.

callback

Type: System.AsyncCallback

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

state

Type: System.Object

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

Return Value

Type: System.IAsyncResult

An IAsyncResult that references the asynchronous operation.

The following code example lists queues in result segments asynchronously.

static void ListQueuesInSegmentsAsync(Uri queueEndpoint, string accountName, string accountKey)
{
    //Create service client for credentialed access to the Queue service.
    CloudQueueClient queueClient = new CloudQueueClient(queueEndpoint, new StorageCredentialsAccountAndKey(accountName, accountKey));

    //Return a page of 10 queues beginning with the specified prefix.
    queueClient.BeginListQueuesSegmented("my", QueueListingDetails.Metadata, 10, null, ListQueuesInSegmentsAsyncCallback, queueClient);
}

static void ListQueuesInSegmentsAsyncCallback(IAsyncResult result)
{
    CloudQueueClient queueClient = (CloudQueueClient)result.AsyncState;
    ResultSegment<CloudQueue> resultSegment = queueClient.EndListQueuesSegmented(result);

    WriteQueuesInResultSegment(resultSegment);

    //Check that the page is complete.
    while (resultSegment.HasMoreResults)
    {
        resultSegment.BeginGetNext(GetNextCallback, resultSegment);
    }
}

static void GetNextCallback(IAsyncResult result)
{
    ResultSegment<CloudQueue> resultSegment = (ResultSegment<CloudQueue>)result.AsyncState;
    resultSegment = resultSegment.EndGetNext(result);
    WriteQueuesInResultSegment(resultSegment);
}

static void WriteQueuesInResultSegment(ResultSegment<CloudQueue> resultSegment)
{
    foreach (CloudQueue queue in resultSegment.Results)
    {
        Console.WriteLine(queue.Name);
    }
}

The BeginListQueuesSegmented method begins an operation to list queues in pages. To specify the page size to return, pass in a non-zero value for the maxResults parameter. Passing in zero for the maxResults parameter returns either the maximum number of results available, or the per-operation limit of 5000 results.

If you have specified a page size, you can check the HasMoreResults property to check whether the page is complete. For example, if you have specified a page size of 10,000, a value which exceeds the per-operation limit, HasMoreResults will return true, indicating that the page is not complete. Note that if you have not specified a page size, HasMoreResults will always be false.

If you have not specified a page size, or the value of maxResults is zero, then check the value of the ContinuationToken property to determine whether there are more results to return. The continuation token is non-null as long as there are more results to return from the service.

Call the GetNext method to return the next segment of results from the service.


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

Development Platforms

Windows Vista, Windows 7 and Windows Server 2008

Target Platforms

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.