Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

CloudQueue.PeekMessages Method

Updated: September 27, 2013

[This topic is part of the Windows Azure Storage Client Library 1.7, which has been deprecated. The current recommended version is Storage Client Library 3.0.]

Peeks a set of messages from the queue.

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

public IEnumerable<CloudQueueMessage> PeekMessages (
	int messageCount
)

Parameters

messageCount

Type: System.Int32

The number of messages to retrieve.

Return Value

Type: System.Collections.Generic.IEnumerable

A enumerable collection of messages.

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.


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

Development Platforms

Windows Vista, Windows 7 and Windows Server 2008

Target Platforms

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.