SALES: 1-800-867-1380

BrokeredMessage.BeginDeadLetter Method (String, String, 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)

public IAsyncResult BeginDeadLetter(
	string deadLetterReason,
	string deadLetterErrorDescription,
	AsyncCallback callback,
	object state
)

Parameters

deadLetterReason
Type: System.String

The reason for deadlettering the message.

deadLetterErrorDescription
Type: System.String

The description information for deadlettering the message.

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.

Exception Condition
ObjectDisposedException

Thrown when the message is in disposed state or the receiver with which the message was received is in disposed state.

InvalidOperationException

Thrown when invoked on a message that has not been received from the message server.

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft