MessageReceiver.OnBeginDeadLetter Method

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Executes upon calling the OnDeadLetter or BeginDeadLetter operation.

protected abstract 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);

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

Protected MustOverride 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

The context information associated by a transaction tracking this operation.

lockTokens

IEnumerable<Guid>

The collection of lock tokens bound to the locked message instances.

propertiesToModify

IDictionary<String,Object>

The properties to modify.

deadLetterReason

String

The reason for deadlettering the messages.

deadLetterErrorDescription

String

The error description for deadlettering the messages.

fromSync

Boolean

The start of the synchronization.

timeout

TimeSpan

The time span the operation waits before it times out.

callback

AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state

Object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

AnIAsyncResult that references the asynchronous operation to move undelivered of messages to the deadletter queue.