CloudQueueClient.ListQueuesSegmentedAsync Method (String, QueueListingDetails, Nullable, QueueContinuationToken, QueueRequestOptions, OperationContext)

Windows Runtime Azure Storage Client Library

previous page next page
Returns a result segment containing a collection of queues whose names begin with the specified prefix.

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

Usage

Visual Basic
Dim instance As CloudQueueClient
Dim prefix As String
Dim detailsIncluded As QueueListingDetails
Dim maxResults As Nullable(Of Integer)
Dim currentToken As QueueContinuationToken
Dim options As QueueRequestOptions
Dim operationContext As OperationContext
Dim returnValue As IAsyncOperation(Of QueueResultSegment)

returnValue = instance.ListQueuesSegmentedAsync(prefix, detailsIncluded, maxResults, currentToken, options, operationContext)

Syntax

Visual Basic
Public Function ListQueuesSegmentedAsync ( _
	prefix As String, _
	detailsIncluded As QueueListingDetails, _
	maxResults As Nullable(Of Integer), _
	currentToken As QueueContinuationToken, _
	options As QueueRequestOptions, _
	operationContext As OperationContext _
) As IAsyncOperation(Of QueueResultSegment)
C#
public IAsyncOperation<QueueResultSegment> ListQueuesSegmentedAsync (
	string prefix,
	QueueListingDetails detailsIncluded,
	Nullable<int> maxResults,
	QueueContinuationToken currentToken,
	QueueRequestOptions options,
	OperationContext operationContext
)
C++
public:
IAsyncOperation<QueueResultSegment^>^ ListQueuesSegmentedAsync (
	String^ prefix, 
	QueueListingDetails detailsIncluded, 
	Nullable<int> maxResults, 
	QueueContinuationToken^ currentToken, 
	QueueRequestOptions^ options, 
	OperationContext^ operationContext
)
J#
public IAsyncOperation<QueueResultSegment> ListQueuesSegmentedAsync (
	String prefix, 
	QueueListingDetails detailsIncluded, 
	Nullable<int> maxResults, 
	QueueContinuationToken currentToken, 
	QueueRequestOptions options, 
	OperationContext operationContext
)
JScript
public function ListQueuesSegmentedAsync (
	prefix : String, 
	detailsIncluded : QueueListingDetails, 
	maxResults : Nullable<int>, 
	currentToken : QueueContinuationToken, 
	options : QueueRequestOptions, 
	operationContext : OperationContext
) : IAsyncOperation<QueueResultSegment>

Parameters

prefix

The queue name prefix.

detailsIncluded

A value that indicates whether to return queue metadata with the listing.

maxResults

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

A QueueContinuationToken token returned by a previous listing operation.

options

An object that specifies additional options for the request.

operationContext

An OperationContext object that represents the context for the current operation.

Return Value

A result segment of queues.

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, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Target Platforms

See Also

previous page start next page