Begins an asynchronous operation to delete a message. Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)
Usage
| Visual Basic |
|---|
Dim instance As CloudQueue Dim message As CloudQueueMessage Dim callback As AsyncCallback Dim state As Object Dim returnValue As IAsyncResult returnValue = instance.BeginDeleteMessage(message, callback, state) |
Syntax
| Visual Basic |
|---|
Public Function BeginDeleteMessage ( _ message As CloudQueueMessage, _ callback As AsyncCallback, _ state As Object _ ) As IAsyncResult |
| C# |
|---|
public IAsyncResult BeginDeleteMessage ( CloudQueueMessage message, AsyncCallback callback, Object state ) |
| C++ |
|---|
public: IAsyncResult^ BeginDeleteMessage ( CloudQueueMessage^ message, AsyncCallback^ callback, Object^ state ) |
| J# |
|---|
| JScript |
|---|
Parameters
- message
Type: Microsoft.WindowsAzure.StorageClient.CloudQueueMessage
A message.
- 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
After a client retrieves a message by calling the BeginGetMessage or BeginGetMessages method, the client is expected to process and delete the message. When a message is retrieved, its PopReceipt property is set to an opaque value that indicates that the message has been read. The value of the message's pop receipt is used to verify that the message being deleted is the same message that was read.
After a client retrieves a message, that message is reserved for deletion until the date and time indicated by the message's NextVisibleTime property, and no other client may retrieve the message during that time interval. If the message is not deleted before the time specified by the NextVisibleTime property, it again becomes visible to other clients. If the message is not subsequently retrieved and deleted by another client, the client that retrieved it can still delete it. If another client does retrieve it, then the first client can no longer delete it.