Storage Client Library for Windows Runtime (Version 7.0)

Peeks a single message from the queue.

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

Syntax

C#

Copy Code

 

public virtual Task<CloudQueueMessage> PeekMessageAsync(
	QueueRequestOptions options,
	OperationContext operationContext
)

C++

Copy Code

 

public:
virtual Task<CloudQueueMessage^>^ PeekMessageAsync(
	QueueRequestOptions^ options,
	OperationContext^ operationContext
)

F#

Copy Code

 

abstract PeekMessageAsync : 
        options:QueueRequestOptions *
        operationContext:OperationContext -> Task<CloudQueueMessage>
override PeekMessageAsync : 
        options:QueueRequestOptions *
        operationContext:OperationContext -> Task<CloudQueueMessage>

VB

Copy Code

 

Public Overridable Function PeekMessageAsync (
	options As QueueRequestOptions,
	operationContext As OperationContext
) As Task(Of CloudQueueMessage)

Parameters

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<CloudQueueMessage>System.Threading.Tasks::Task<CloudQueueMessage^>^System.Threading.Tasks.Task<CloudQueueMessage>System.Threading.Tasks.Task(Of CloudQueueMessage)

A message.

See Also

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

Return to top