CloudQueue.GetMessagesAsync Method (Int32, Nullable, QueueRequestOptions, OperationContext)

Windows Runtime Azure Storage Client Library

previous page next page
Gets a list of messages from the queue.

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

Usage

Visual Basic
Dim instance As CloudQueue
Dim messageCount As Integer
Dim visibilityTimeout As Nullable(Of TimeSpan)
Dim options As QueueRequestOptions
Dim operationContext As OperationContext
Dim returnValue As IAsyncOperation(Of IEnumerable(Of CloudQueueMessage))

returnValue = instance.GetMessagesAsync(messageCount, visibilityTimeout, options, operationContext)

Syntax

Visual Basic
Public Function GetMessagesAsync ( _
	messageCount As Integer, _
	visibilityTimeout As Nullable(Of TimeSpan), _
	options As QueueRequestOptions, _
	operationContext As OperationContext _
) As IAsyncOperation(Of IEnumerable(Of CloudQueueMessage))
C#
public IAsyncOperation<IEnumerable<CloudQueueMessage>> GetMessagesAsync (
	int messageCount,
	Nullable<TimeSpan> visibilityTimeout,
	QueueRequestOptions options,
	OperationContext operationContext
)
C++
public:
IAsyncOperation<IEnumerable<CloudQueueMessage^>^>^ GetMessagesAsync (
	int messageCount, 
	Nullable<TimeSpan> visibilityTimeout, 
	QueueRequestOptions^ options, 
	OperationContext^ operationContext
)
J#
public IAsyncOperation<IEnumerable<CloudQueueMessage>> GetMessagesAsync (
	int messageCount, 
	Nullable<TimeSpan> visibilityTimeout, 
	QueueRequestOptions options, 
	OperationContext operationContext
)
JScript
public function GetMessagesAsync (
	messageCount : int, 
	visibilityTimeout : Nullable<TimeSpan>, 
	options : QueueRequestOptions, 
	operationContext : OperationContext
) : IAsyncOperation<IEnumerable<CloudQueueMessage>>

Parameters

messageCount

The number of messages to retrieve.

visibilityTimeout

The visibility timeout interval.

options

A QueueRequestOptions object that specifies additional options for the request.

operationContext

An OperationContext object that represents the context for the current operation.

Return Value

An enumerable collection of messages.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Target Platforms

See Also

previous page start next page