MessageReceiver.OnDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, String, String, TimeSpan) Method

Definition

Executes the move to dead letter queue action.

protected virtual void OnDeadLetter (Microsoft.ServiceBus.Tracing.TrackingContext trackingContext, System.Collections.Generic.IEnumerable<Guid> lockTokens, System.Collections.Generic.IDictionary<string,object> propertiesToModify, string deadLetterReason, string deadLetterErrorDescription, TimeSpan timeout);
abstract member OnDeadLetter : Microsoft.ServiceBus.Tracing.TrackingContext * seq<Guid> * System.Collections.Generic.IDictionary<string, obj> * string * string * TimeSpan -> unit
override this.OnDeadLetter : Microsoft.ServiceBus.Tracing.TrackingContext * seq<Guid> * System.Collections.Generic.IDictionary<string, obj> * string * string * TimeSpan -> unit
Protected Overridable Sub OnDeadLetter (trackingContext As TrackingContext, lockTokens As IEnumerable(Of Guid), propertiesToModify As IDictionary(Of String, Object), deadLetterReason As String, deadLetterErrorDescription As String, timeout As TimeSpan)

Parameters

trackingContext
TrackingContext

TrackingContext to use.

lockTokens
IEnumerable<Guid>

The lock tokens.

propertiesToModify
IDictionary<String,Object>
deadLetterReason
String

The reason for deadlettering the message.

deadLetterErrorDescription
String

The description information for deadlettering the message.

timeout
TimeSpan

The timeout.

Applies to