[This topic is part of the Microsoft Azure Storage Client Library 1.7, which has been deprecated. See Storage Client Library for the latest version.]
Peeks a set of messages from the queue. Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)
Peeks a set of messages from the queue. Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)
Usage
| Visual Basic |
|---|
Dim instance As CloudQueue Dim messageCount As Integer Dim returnValue As IEnumerable(Of CloudQueueMessage) returnValue = instance.PeekMessages(messageCount) |
Syntax
| Visual Basic |
|---|
Public Function PeekMessages ( _ messageCount As Integer _ ) As IEnumerable(Of CloudQueueMessage) |
| C# |
|---|
public IEnumerable<CloudQueueMessage> PeekMessages ( int messageCount ) |
| C++ |
|---|
public: IEnumerable<CloudQueueMessage^>^ PeekMessages ( int messageCount ) |
| J# |
|---|
| JScript |
|---|
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.