| CloudQueueClient.ListQueuesSegmented Method (String, QueueListingDetails, Int32, ResultContinuation) |
| See Also Example |
|
|
Returns a result segment containing a collection of queues whose names begin with the specified prefix, with each listing the specified queue details. 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 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
| Visual Basic |
|---|
Dim instance As CloudQueueClient Dim prefix As String Dim detailsIncluded As QueueListingDetails Dim maxResults As Integer Dim continuationToken As ResultContinuation Dim returnValue As ResultSegment(Of CloudQueue) returnValue = instance.ListQueuesSegmented(prefix, detailsIncluded, maxResults, continuationToken) |
Syntax
| Visual Basic |
|---|
Public Function ListQueuesSegmented ( _ prefix As String, _ detailsIncluded As QueueListingDetails, _ maxResults As Integer, _ continuationToken As ResultContinuation _ ) As ResultSegment(Of CloudQueue) |
| C# |
|---|
public ResultSegment<CloudQueue> ListQueuesSegmented ( string prefix, QueueListingDetails detailsIncluded, int maxResults, ResultContinuation continuationToken ) |
| C++ |
|---|
public: ResultSegment<CloudQueue^>^ ListQueuesSegmented ( String^ prefix, QueueListingDetails detailsIncluded, int maxResults, ResultContinuation^ continuationToken ) |
| J# |
|---|
| JScript |
|---|
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.
Return Value
Type: Microsoft.WindowsAzure.StorageClient.ResultSegment A result segment containing a collection of queues.Example
The following code example lists queues in pages of ten.
| Copy Code | |
|---|---|
static void ListQueuesInSegments(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.
ResultSegment<CloudQueue> resultSegment = queueClient.ListQueuesSegmented("my", QueueListingDetails.None, 10, null);
WriteQueuesInResultSegment(resultSegment);
Console.WriteLine();
//Check that the page is complete.
while (resultSegment.HasMoreResults)
{
resultSegment = resultSegment.GetNext();
WriteQueuesInResultSegment(resultSegment);
}
Console.WriteLine();
}
| |
Remarks
The ListQueuesSegmented method lists 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.