SALES: 1-800-867-1380

SubscriptionClient.BeginDeadLetter Method (Guid, String, String, AsyncCallback, Object)

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

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

public final function BeginDeadLetter(
	lockToken : Guid, 
	deadLetterReason : String, 
	deadLetterErrorDescription : String, 
	callback : AsyncCallback, 
	state : Object
) : IAsyncResult

Parameters

lockToken
Type: System.Guid
The lock token bound to the locked message instance.
deadLetterReason
Type: System.String
The reason for deadlettering the message.
deadLetterErrorDescription
Type: System.String
The error description 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 state information about the asynchronous operation.

Return Value

Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation to move a message to the dead letter queue.

ExceptionCondition
TimeoutException

Thrown if the operation exceeded the timeout value set by OperationTimeout.

OperationCanceledException

Thrown if the client entity has been closed or aborted.

MessageLockLostException

Thrown if the message represented by lockToken has lost the message lock.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft