Begins an asynchronous operation to peek a message from the queue. Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)
Usage
| Visual Basic |
|---|
Dim instance As CloudQueue Dim callback As AsyncCallback Dim state As Object Dim returnValue As IAsyncResult returnValue = instance.BeginPeekMessage(callback, state) |
Syntax
| Visual Basic |
|---|
Public Function BeginPeekMessage ( _ callback As AsyncCallback, _ state As Object _ ) As IAsyncResult |
| C# |
|---|
public IAsyncResult BeginPeekMessage ( AsyncCallback callback, Object state ) |
| C++ |
|---|
public: IAsyncResult^ BeginPeekMessage ( AsyncCallback^ callback, Object^ state ) |
| J# |
|---|
| JScript |
|---|
Parameters
- 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 a message is retrieved from the queue using BeginPeekMessage, the message is not dequeued and the visibility of the message remains unchanged. The message remains available to other clients until a client retrieves the message with a call to BeginGetMessage. The call to BeginPeekMessage does not update the message's PopReceipt value, so the message cannot subsequently be deleted. Additionally, calling BeginPeekMessage does not update the message's NextVisibleTime or DequeueCount properties.
Only messages that are visible may be retrieved with BeginPeekMessage.