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)
Usage
| Visual Basic |
|---|
Dim instance As CloudQueue Dim messageCount As Integer Dim callback As AsyncCallback Dim state As Object Dim returnValue As IAsyncResult returnValue = instance.BeginPeekMessages(messageCount, callback, state) |
Syntax
| Visual Basic |
|---|
Public Function BeginPeekMessages ( _ messageCount As Integer, _ callback As AsyncCallback, _ state As Object _ ) As IAsyncResult |
| C# |
|---|
public IAsyncResult BeginPeekMessages ( int messageCount, AsyncCallback callback, Object state ) |
| C++ |
|---|
public: IAsyncResult^ BeginPeekMessages ( int messageCount, AsyncCallback^ callback, Object^ state ) |
| J# |
|---|
| JScript |
|---|
Parameters
- messageCount
Type: System.Int32
The number of messages to retrieve.
- callback
Type: System.AsyncCallback
The callback delegate that will receive notification when the asynchronous operation completes.
- state
Type: System.Object
A user-defined object that will be passed to the callback delegate.
Return Value
Type: System.IAsyncResultAn IAsyncResult that references the asynchronous operation.Remarks
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.