Share via

SubscriptionClient.Abandon Method

  • Reference

Definition

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

Overloads

Abandon(Guid)

Discards the message and relinquishes the message lock ownership.
Abandon(Guid, IDictionary<String,Object>)

Discards the message and relinquishes the message lock ownership.

Abandon(Guid)

Discards the message and relinquishes the message lock ownership.

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

Parameters

lockToken
Guid

The lock token bound to the locked message instance to abandon.

Exceptions

TimeoutException

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

OperationCanceledException

Thrown if the client entity has been closed or aborted.

Remarks

When the client fails to get the message from the queue/topic, this method should be called. Service Bus will increment the delivery count of the message. The client now can either attempt to receive the message again or move it to the dead-letter queue.

Applies to

Abandon(Guid, IDictionary<String,Object>)

Discards the message and relinquishes the message lock ownership.

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

Parameters

lockToken
Guid

The lock token bound to the locked message instance to abandon.

propertiesToModify
IDictionary<String,Object>

A collection of property objects to be modified.

Remarks

When the client fails to get the message from the queue/topic, this method should be called. Service Bus will increment the delivery count of the message. The client now can either attempt to receive the message again or move it to the dead-letter queue.

Applies to