SALES: 1-800-867-1380

MessageReceiver.OnBeginDeadLetter Method

Executes upon calling the OnDeadLetter or BeginDeadLetter operation.

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

protected abstract IAsyncResult OnBeginDeadLetter(
	TrackingContext trackingContext,
	IEnumerable<Guid> lockTokens,
	IDictionary<string, Object> propertiesToModify,
	string deadLetterReason,
	string deadLetterErrorDescription,
	bool fromSync,
	TimeSpan timeout,
	AsyncCallback callback,
	Object state
)

Parameters

trackingContext
Type: Microsoft.ServiceBus.Tracing.TrackingContext
The context information associated by a transaction tracking this operation.
lockTokens
Type: System.Collections.Generic.IEnumerable<Guid>
The collection of lock tokens bound to the locked message instances.
propertiesToModify
Type: System.Collections.Generic.IDictionary<String, Object>
The properties to modify.
deadLetterReason
Type: System.String
The reason for deadlettering the messages.
deadLetterErrorDescription
Type: System.String
The error description for deadlettering the messages.
fromSync
Type: System.Boolean
The start of the synchronization.
timeout
Type: System.TimeSpan
The time span the operation waits before it times out.
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 undelivered of messages to the deadletter queue.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft