OnDeadLetter Method

Deadletters a message.

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

Syntax

'Declaration
Protected Overrides Sub OnDeadLetter ( _
    trackingContext As TrackingContext, _
    lockTokens As IEnumerable(Of Guid), _
    deadLetterReason As String, _
    deadLetterErrorDescription As String, _
    timeout As TimeSpan _
)
'Usage
Dim trackingContext As TrackingContext
Dim lockTokens As IEnumerable(Of Guid)
Dim deadLetterReason As String
Dim deadLetterErrorDescription As String
Dim timeout As TimeSpan

Me.OnDeadLetter(trackingContext, _
    lockTokens, deadLetterReason, deadLetterErrorDescription, _
    timeout)

protected override void OnDeadLetter(
    TrackingContext trackingContext,
    IEnumerable<Guid> lockTokens,
    string deadLetterReason,
    string deadLetterErrorDescription,
    TimeSpan timeout
)

protected:
virtual void OnDeadLetter(
    TrackingContext^ trackingContext, 
    IEnumerable<Guid>^ lockTokens, 
    String^ deadLetterReason, 
    String^ deadLetterErrorDescription, 
    TimeSpan timeout
) override

abstract OnDeadLetter : 
        trackingContext:TrackingContext * 
        lockTokens:IEnumerable<Guid> * 
        deadLetterReason:string * 
        deadLetterErrorDescription:string * 
        timeout:TimeSpan -> unit 
override OnDeadLetter : 
        trackingContext:TrackingContext * 
        lockTokens:IEnumerable<Guid> * 
        deadLetterReason:string * 
        deadLetterErrorDescription:string * 
        timeout:TimeSpan -> unit 

protected override function OnDeadLetter(
    trackingContext : TrackingContext, 
    lockTokens : IEnumerable<Guid>, 
    deadLetterReason : String, 
    deadLetterErrorDescription : String, 
    timeout : TimeSpan
)

Parameters

• trackingContext
  Type: Microsoft.ServiceBus.Tracing. . :: . .TrackingContext
  The context information associated by a transaction tracking this operation.

• lockTokens
  Type: System.Collections.Generic. . :: . .IEnumerable< (Of < ( <'Guid> ) > ) >
  The collection of lock tokens bound to the locked message instances.

• deadLetterReason
  Type: System. . :: . .String
  The reason for deadlettering the messages.

• deadLetterErrorDescription
  Type: System. . :: . .String
  The error description for deadlettering the messages.

• timeout
  Type: System. . :: . .TimeSpan
  The time span interval the operation waits before it times out.

See Also

Reference

MessageSession Class

Microsoft.ServiceBus.Messaging Namespace