BrokeredMessage.BeginDeadLetter Method (IDictionary<String, Object>, AsyncCallback, Object)

Begins an asynchronous operation to move the message to the dead letter queue.

Namespace:   Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

Syntax

public IAsyncResult BeginDeadLetter(
    IDictionary<string, object> propertiesToModify,
    AsyncCallback callback,
    object state
)

public:
IAsyncResult^ BeginDeadLetter(
    IDictionary<String^, Object^>^ propertiesToModify,
    AsyncCallback^ callback,
    Object^ state
)

member BeginDeadLetter : 
        propertiesToModify:IDictionary<string, Object> *
        callback:AsyncCallback *
        state:Object -> IAsyncResult

Public Function BeginDeadLetter (
    propertiesToModify As IDictionary(Of String, Object),
    callback As AsyncCallback,
    state As Object
) As IAsyncResult

Parameters

• propertiesToModify
  Type: System.Collections.Generic.IDictionary<String, Object>

  The key-value pair collection of properties to modify.

• callback
  Type: System.AsyncCallback

  An AsyncCallback delegate that references the method to invoke when the operation is complete.

• state
  Type: System.Object

  A user-defined object that contains information about the receive operation. This object is passed to the EndDeadLetter delegate when the operation is complete.

Return Value

Type: System.IAsyncResult

An IAsyncResult that references the asynchronous request to dead letter the message.

Remarks

Enables you to modify message properties when performing a BeginDeadLetter operation.

See Also

BeginDeadLetter Overload
BrokeredMessage Class
Microsoft.ServiceBus.Messaging Namespace

Return to top