Storage Client Library for Windows Phone (Version 7.0)

Microsoft Windows Azure Storage Blob

CloudQueue.PeekMessageAsync Method (QueueRequestOptions, OperationContext, CancellationToken) (Microsoft.WindowsAzure.Storage.Queue)

Initiates an asynchronous operation to get a single message from the queue.

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

Syntax

C#
System_CAPS_copycodeCopy Code
  
[DoesServiceRequestAttribute]
public virtual Task<CloudQueueMessage> PeekMessageAsync(
	QueueRequestOptions options,
	OperationContext operationContext,
	CancellationToken cancellationToken
)
C++
System_CAPS_copycodeCopy Code
  
public:
[DoesServiceRequestAttribute]
virtual Task<CloudQueueMessage^>^ PeekMessageAsync(
	QueueRequestOptions^ options,
	OperationContext^ operationContext,
	CancellationToken cancellationToken
)
F#
System_CAPS_copycodeCopy Code
  
[<DoesServiceRequestAttribute>]
abstract PeekMessageAsync : 
        options:QueueRequestOptions *
        operationContext:OperationContext *
        cancellationToken:CancellationToken -> Task<CloudQueueMessage>
[<DoesServiceRequestAttribute>]
override PeekMessageAsync : 
        options:QueueRequestOptions *
        operationContext:OperationContext *
        cancellationToken:CancellationToken -> Task<CloudQueueMessage>
VB
System_CAPS_copycodeCopy Code
  
<DoesServiceRequestAttribute>
Public Overridable Function PeekMessageAsync (
	options As QueueRequestOptions,
	operationContext As OperationContext,
	cancellationToken As CancellationToken
) 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.

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

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

See Also

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

Return to top