Updated: September 27, 2013
Begins an asynchronous operation to peek a set of messages from the queue. Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)
public IAsyncResult BeginPeekMessages ( int messageCount, AsyncCallback callback, Object state )
The number of messages to retrieve.
The callback delegate that will receive notification when the asynchronous operation completes.
A user-defined object that will be passed to the callback delegate.
Return ValueType: System.IAsyncResultAn IAsyncResult that references the asynchronous operation.
When messages are retrieved from the queue using BeginPeekMessages, 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 BeginGetMessages. The call to BeginPeekMessages does not update a message's PopReceipt value, so the message cannot subsequently be deleted. Additionally, calling BeginPeekMessages does not update a message's NextVisibleTime or DequeueCount properties.
Only messages that are visible may be retrieved with BeginPeekMessages. The maximum number of messages that may be retrieved with a call to BeginPeekMessages is 32.
Development PlatformsWindows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012