QueueClient.DeadLetter Method

Definition

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
System.Guid

The lock token bound to the locked message instance.

deadLetterReason
System.String

The reason for deadlettering the message.

deadLetterErrorDescription
System.String

The error description for deadlettering the message.

Implements

Microsoft.ServiceBus.Messaging.IMessageReceiver.DeadLetter(System.Guid,System.String,System.String)

Exceptions

System.TimeoutException

Thrown if the operation exceeded the timeout value set by OperationTimeout

System.OperationCanceledException

Thrown if the client entity has been closed or aborted.

Thrown if the message represented by the 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
System.Guid

The lock token bound to the locked message instance.

Implements

Microsoft.ServiceBus.Messaging.IMessageReceiver.DeadLetter(System.Guid)

Exceptions

System.TimeoutException

Thrown if the operation exceeded the timeout value set by OperationTimeout

System.OperationCanceledException

Thrown if the client entity has been closed or aborted.

Thrown if the message represented by the 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
System.Guid

The lock token bound to the locked message instance.

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

The properties of the message to modify.

Implements

Microsoft.ServiceBus.Messaging.IMessageReceiver.DeadLetter(System.Guid,System.Collections.Generic.IDictionary{System.String,System.Object})

Applies to