CloudQueue.PeekMessagesAsync Method (Int32, QueueRequestOptions, OperationContext, CancellationToken) (Microsoft.WindowsAzure.Storage.Queue)
From Microsoft.WindowsAzure.Storage.Queue
C#
C++
F#
VB
CloudQueue.::..PeekMessagesAsync Method (Int32, QueueRequestOptions, OperationContext, CancellationToken)(Int32, QueueRequestOptions^, OperationContext^, CancellationToken)(Int32, QueueRequestOptions, OperationContext, CancellationToken)(Int32, QueueRequestOptions, OperationContext, CancellationToken)
Peeks a list of messages from the queue.
Namespace:
Microsoft.WindowsAzure.Storage.Queue
Assembly:
Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)
Syntax
public virtual Task<IEnumerable<CloudQueueMessage>> PeekMessagesAsync(
int messageCount,
QueueRequestOptions options,
OperationContext operationContext,
CancellationToken cancellationToken
)
C++public:
virtual Task<IEnumerable<CloudQueueMessage^>^>^ PeekMessagesAsync(
int messageCount,
QueueRequestOptions^ options,
OperationContext^ operationContext,
CancellationToken cancellationToken
)
abstract PeekMessagesAsync :
messageCount:int *
options:QueueRequestOptions *
operationContext:OperationContext *
cancellationToken:CancellationToken -> Task<IEnumerable<CloudQueueMessage>>
override PeekMessagesAsync :
messageCount:int *
options:QueueRequestOptions *
operationContext:OperationContext *
cancellationToken:CancellationToken -> Task<IEnumerable<CloudQueueMessage>>
Public Overridable Function PeekMessagesAsync (
messageCount As Integer,
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.
- 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.
Return to top
Peeks a list of messages from the queue.
Syntax
public virtual Task<IEnumerable<CloudQueueMessage>> PeekMessagesAsync( int messageCount, QueueRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken )
C++
public: virtual Task<IEnumerable<CloudQueueMessage^>^>^ PeekMessagesAsync( int messageCount, QueueRequestOptions^ options, OperationContext^ operationContext, CancellationToken cancellationToken )
abstract PeekMessagesAsync : messageCount:int * options:QueueRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task<IEnumerable<CloudQueueMessage>> override PeekMessagesAsync : messageCount:int * options:QueueRequestOptions * operationContext:OperationContext * cancellationToken:CancellationToken -> Task<IEnumerable<CloudQueueMessage>>
Public Overridable Function PeekMessagesAsync ( messageCount As Integer, 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.
- 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.