Storage Client Library for Windows Runtime (Version 7.0)

Peeks 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>> PeekMessagesAsync(
	int messageCount,
	QueueRequestOptions options,
	OperationContext operationContext
)

C++

Copy Code

 

public:
virtual Task<IEnumerable<CloudQueueMessage^>^>^ PeekMessagesAsync(
	int messageCount,
	QueueRequestOptions^ options,
	OperationContext^ operationContext
)

F#

Copy Code

 

abstract PeekMessagesAsync : 
        messageCount:int *
        options:QueueRequestOptions *
        operationContext:OperationContext -> Task<IEnumerable<CloudQueueMessage>>
override PeekMessagesAsync : 
        messageCount:int *
        options:QueueRequestOptions *
        operationContext:OperationContext -> Task<IEnumerable<CloudQueueMessage>>

VB

Copy Code

 

Public Overridable Function PeekMessagesAsync (
	messageCount As Integer,
	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.

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

An enumerable collection of messages.

See Also

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

Return to top