Storage Client Library for Windows Runtime (Version 7.0)

Gets a list of messages from the queue.

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

Syntax

C#

Copy Code

 

public virtual Task<IEnumerable<CloudQueueMessage>> GetMessagesAsync(
	int messageCount,
	Nullable<TimeSpan> visibilityTimeout,
	QueueRequestOptions options,
	OperationContext operationContext,
	CancellationToken cancellationToken
)

C++

Copy Code

 

public:
virtual Task<IEnumerable<CloudQueueMessage^>^>^ GetMessagesAsync(
	int messageCount,
	Nullable<TimeSpan> visibilityTimeout,
	QueueRequestOptions^ options,
	OperationContext^ operationContext,
	CancellationToken cancellationToken
)

F#

Copy Code

 

abstract GetMessagesAsync : 
        messageCount:int *
        visibilityTimeout:Nullable<TimeSpan> *
        options:QueueRequestOptions *
        operationContext:OperationContext *
        cancellationToken:CancellationToken -> Task<IEnumerable<CloudQueueMessage>>
override GetMessagesAsync : 
        messageCount:int *
        visibilityTimeout:Nullable<TimeSpan> *
        options:QueueRequestOptions *
        operationContext:OperationContext *
        cancellationToken:CancellationToken -> Task<IEnumerable<CloudQueueMessage>>

VB

Copy Code

 

Public Overridable Function GetMessagesAsync (
	messageCount As Integer,
	visibilityTimeout As Nullable(Of TimeSpan),
	options As QueueRequestOptions,
	operationContext As OperationContext,
	cancellationToken As CancellationToken
) As Task(Of IEnumerable(Of CloudQueueMessage))

Parameters

messageCount

Type: System.Int32System::Int32System.Int32System.Int32

The number of messages to retrieve.

visibilityTimeout

Type: System.Nullable<TimeSpan>System::Nullable<TimeSpan>System.Nullable<TimeSpan>System.Nullable(Of TimeSpan)

The visibility timeout interval.

options

Type: Microsoft.WindowsAzure.Storage.Queue.QueueRequestOptionsMicrosoft.WindowsAzure.Storage.Queue::QueueRequestOptions^Microsoft.WindowsAzure.Storage.Queue.QueueRequestOptionsMicrosoft.WindowsAzure.Storage.Queue.QueueRequestOptions

A QueueRequestOptions 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.

cancellationToken

Type: System.Threading.CancellationTokenSystem.Threading::CancellationTokenSystem.Threading.CancellationTokenSystem.Threading.CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Return Value

Type: System.Threading.Tasks.Task<IEnumerable<CloudQueueMessage>>System.Threading.Tasks::Task<IEnumerable<CloudQueueMessage^>^>^System.Threading.Tasks.Task<IEnumerable<CloudQueueMessage>>System.Threading.Tasks.Task(Of IEnumerable(Of CloudQueueMessage))

An enumerable collection of messages.

See Also

GetMessagesAsync Overload
CloudQueue Class
Microsoft.WindowsAzure.Storage.Queue Namespace

Return to top