SubscriptionClient.Complete(Guid) Method

Definition

Completes processing of a message.

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

Parameters

lockToken
System.Guid

The lock token bound to the locked message instance.

Implements

Microsoft.ServiceBus.Messaging.IMessageReceiver.Complete(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 lockToken has lost the message lock.

Remarks

This method is used as a handshake between the client and Service Bus for a guaranteed delivery of the message. If the client failed before calling this method, the message will be kept in the queue.

Applies to