MessageSession.OnBeginDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, String, String, Boolean, TimeSpan, AsyncCallback, Object) Method

Definition

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

Parameters

trackingContext
TrackingContext

TrackingContext to use.

lockTokens
System.Collections.Generic.IEnumerable<System.Guid>

The lock tokens.

propertiesToModify
System.Collections.Generic.IDictionary<System.String,System.Object>

message properties to modify.

deadLetterReason
System.String

The reason for deadlettering the message.

deadLetterErrorDescription
System.String

The description information for deadlettering the message.

fromSync
System.Boolean

true if this was called from a sync method.

timeout
System.TimeSpan

The timeout.

callback
System.AsyncCallback

The callback.

state
System.Object

The state.

Returns

System.IAsyncResult

.

Applies to