MessageReceiver.Complete(Guid) Method

  • Reference

Definition

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

Completes the receive operation on a message. If using AMQP, this operation can only be performed on messages that were received by this receiver.

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 of the BrokeredMessage. This is only available when a message is received in peek-lock mode. The lock token is used internally to complete or abandon a message.

Remarks

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

Applies to