SubscriptionClient.Complete(Guid) Method

Reference

Definition

Namespace:: Microsoft.ServiceBus.Messaging

Assembly:: Microsoft.ServiceBus.dll

Package:: WindowsAzure.ServiceBus v6.2.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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: 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.

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