Share via

SubscriptionClient.DeadLetter Method

  • Reference

Definition

Namespace:
Microsoft.ServiceBus.Messaging
Assembly:
Microsoft.ServiceBus.dll
Package:
WindowsAzure.ServiceBus v6.2.2

Overloads

DeadLetter(Guid, String, String)

Moves the undelivered message to the dead letter queue.
DeadLetter(Guid)

Moves the undelivered message to the dead letter queue.
DeadLetter(Guid, IDictionary<String,Object>)

Moves the undelivered message to the dead letter queue.

DeadLetter(Guid, String, String)

Moves the undelivered message to the dead letter queue.

public void DeadLetter (Guid lockToken, string deadLetterReason, string deadLetterErrorDescription);
abstract member DeadLetter : Guid * string * string -> unit
override this.DeadLetter : Guid * string * string -> unit
Public Sub DeadLetter (lockToken As Guid, deadLetterReason As String, deadLetterErrorDescription As String)

Parameters

lockToken
Guid

The lock token bound to the locked message instance.

deadLetterReason
String

The reason for deadlettering the message.

deadLetterErrorDescription
String

The error description for deadlettering the message.

Exceptions

TimeoutException

Thrown if the operation exceeded the timeout value set by OperationTimeout.

OperationCanceledException

Thrown if the client entity has been closed or aborted.

MessageLockLostException

Thrown if the message represented by lockToken has lost the message lock.

Applies to

DeadLetter(Guid)

Moves the undelivered message to the dead letter queue.

public void DeadLetter (Guid lockToken);
abstract member DeadLetter : Guid -> unit
override this.DeadLetter : Guid -> unit
Public Sub DeadLetter (lockToken As Guid)

Parameters

lockToken
Guid

The lock token bound to the locked message instance.

Exceptions

TimeoutException

Thrown if the operation exceeded the timeout value set by OperationTimeout.

OperationCanceledException

Thrown if the client entity has been closed or aborted.

MessageLockLostException

Thrown if the message represented by lockToken has lost the message lock.

Applies to

DeadLetter(Guid, IDictionary<String,Object>)

Moves the undelivered message to the dead letter queue.

public void DeadLetter (Guid lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify);
abstract member DeadLetter : Guid * System.Collections.Generic.IDictionary<string, obj> -> unit
override this.DeadLetter : Guid * System.Collections.Generic.IDictionary<string, obj> -> unit
Public Sub DeadLetter (lockToken As Guid, propertiesToModify As IDictionary(Of String, Object))

Parameters

lockToken
Guid

The lock token bound to the locked message instance.

propertiesToModify
IDictionary<String,Object>

The properties to modify.

Applies to