Storage Client Library for Windows Phone (Version 7.0)

Microsoft Windows Azure Storage Blob

CloudQueue.GetMessagesAsync Method (Int32, Nullable(TimeSpan), QueueRequestOptions, OperationContext) (Microsoft.WindowsAzure.Storage.Queue)

Initiates an asynchronous operation to get the specified number of messages from the queue using the specified request options and operation context. This operation marks the retrieved messages as invisible in the queue for the default visibility timeout period.

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

Syntax

C#
System_CAPS_copycodeCopy Code
  
[DoesServiceRequestAttribute]
public virtual Task<IEnumerable<CloudQueueMessage>> GetMessagesAsync(
	int messageCount,
	Nullable<TimeSpan> visibilityTimeout,
	QueueRequestOptions options,
	OperationContext operationContext
)
C++
System_CAPS_copycodeCopy Code
  
public:
[DoesServiceRequestAttribute]
virtual Task<IEnumerable<CloudQueueMessage^>^>^ GetMessagesAsync(
	int messageCount,
	Nullable<TimeSpan> visibilityTimeout,
	QueueRequestOptions^ options,
	OperationContext^ operationContext
)
F#
System_CAPS_copycodeCopy Code
  
[<DoesServiceRequestAttribute>]
abstract GetMessagesAsync : 
        messageCount:int *
        visibilityTimeout:Nullable<TimeSpan> *
        options:QueueRequestOptions *
        operationContext:OperationContext -> Task<IEnumerable<CloudQueueMessage>>
[<DoesServiceRequestAttribute>]
override GetMessagesAsync : 
        messageCount:int *
        visibilityTimeout:Nullable<TimeSpan> *
        options:QueueRequestOptions *
        operationContext:OperationContext -> Task<IEnumerable<CloudQueueMessage>>
VB
System_CAPS_copycodeCopy Code
  
<DoesServiceRequestAttribute>
Public Overridable Function GetMessagesAsync (
	messageCount As Integer,
	visibilityTimeout As Nullable(Of TimeSpan),
	options As QueueRequestOptions,
	operationContext As OperationContext
) 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)

A TimeSpan specifying 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.

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))

A Task<TResult><TResult><'TResult>(Of TResult) object that is an enumerable collection of type CloudQueueMessage that represents the asynchronous operation.

See Also

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

Return to top