This topic has not yet been rated - Rate this topic

CloudQueue.PeekMessages Method

Peeks a set of messages from the queue.

Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)

Usage

'Usage
Dim instance As CloudQueue
Dim messageCount As Integer
Dim returnValue As IEnumerable(Of CloudQueueMessage)

returnValue = instance.PeekMessages(messageCount)

Syntax

C++

public IEnumerable<CloudQueueMessage> PeekMessages (
	int messageCount
)

public IEnumerable<CloudQueueMessage> PeekMessages (
	int messageCount
)

JScript

public function PeekMessages (
	messageCount : int
) : IEnumerable<CloudQueueMessage>

Parameters

messageCount

Type: System.Int32

The number of messages to retrieve.

Return Value

Type: System.Collections.Generic.IEnumerable

A enumerable collection of messages.

Remarks

When messages are retrieved from the queue using PeekMessages, the message is not dequeued and the visibility of the messages remains unchanged. The messages remain available to other clients until a client retrieves them with a call to GetMessages. The call to PeekMessages does not update a message's PopReceipt value, so the message cannot subsequently be deleted. Additionally, calling PeekMessages does not update a message's NextVisibleTime or DequeueCount properties.

Only messages that are visible may be retrieved with PeekMessages. The maximum number of messages that may be retrieved with a call to PeekMessages is 32.

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 and Windows Server 2008

Target Platforms

Reference

CloudQueue Class
CloudQueue Members
Microsoft.WindowsAzure.StorageClient Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)