MessageSession.OnBeginDeadLetter Method

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Executes the begin move to dead letter queue action.

protected override IAsyncResult OnBeginDeadLetter (Microsoft.ServiceBus.Tracing.TrackingContext trackingContext, System.Collections.Generic.IEnumerable<Guid> lockTokens, System.Collections.Generic.IDictionary<string,object> propertiesToModify, string deadLetterReason, string deadLetterErrorDescription, bool fromSync, TimeSpan timeout, AsyncCallback callback, object state);

override this.OnBeginDeadLetter : Microsoft.ServiceBus.Tracing.TrackingContext * seq<Guid> * System.Collections.Generic.IDictionary<string, obj> * string * string * bool * TimeSpan * AsyncCallback * obj -> IAsyncResult

Protected Overrides Function OnBeginDeadLetter (trackingContext As TrackingContext, lockTokens As IEnumerable(Of Guid), propertiesToModify As IDictionary(Of String, Object), deadLetterReason As String, deadLetterErrorDescription As String, fromSync As Boolean, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

trackingContext

TrackingContext

TrackingContext to use.

lockTokens

IEnumerable<Guid>

The lock tokens.

propertiesToModify

IDictionary<String,Object>

message properties to modify.

deadLetterReason

String

The reason for deadlettering the message.

deadLetterErrorDescription

String

The description information for deadlettering the message.

fromSync

Boolean

true if this was called from a sync method.

timeout

TimeSpan

The timeout.

callback

AsyncCallback

The callback.

state

Object

The state.

Returns

IAsyncResult

.