C#C++F#VB
CloudQueue.::..GetMessagesAsync Method (Int32, Nullable<TimeSpan>, QueueRequestOptions, OperationContext, CancellationToken)(Int32, Nullable<TimeSpan>, QueueRequestOptions^, OperationContext^, CancellationToken)(Int32, Nullable<TimeSpan>, QueueRequestOptions, OperationContext, CancellationToken)(Int32, Nullable(Of TimeSpan), QueueRequestOptions, OperationContext, CancellationToken)
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.
Assembly: Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)
Syntax
[DoesServiceRequestAttribute] public virtual Task<IEnumerable<CloudQueueMessage>> GetMessagesAsync( int messageCount, Nullable<TimeSpan> visibilityTimeout, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken )
C++
public: [DoesServiceRequestAttribute] virtual Task<IEnumerable<CloudQueueMessage^>^>^ GetMessagesAsync( int messageCount, Nullable<TimeSpan> visibilityTimeout, QueueRequestOptions^ options, OperationContext^ operationContext, CancellationToken cancellationToken )
[<DoesServiceRequestAttribute>] abstract GetMessagesAsync : messageCount:int * visibilityTimeout:Nullable<TimeSpan> * options:QueueRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task<IEnumerable<CloudQueueMessage>> [<DoesServiceRequestAttribute>] override GetMessagesAsync : messageCount:int * visibilityTimeout:Nullable<TimeSpan> * options:QueueRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task<IEnumerable<CloudQueueMessage>>
<DoesServiceRequestAttribute> 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)
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.
- 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))A Task<TResult><TResult><'TResult>(Of TResult) object that is an enumerable collection of type CloudQueueMessage that represents the asynchronous operation.