QueueClient.CompleteAsync(String) Method

Reference

Definition

Namespace:: Microsoft.Azure.ServiceBus

Assembly:: Microsoft.Azure.ServiceBus.dll

Package:: Microsoft.Azure.ServiceBus v5.2.0

Source:: QueueClient.cs

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 a Message using its lock token. This will delete the message from the queue.

public System.Threading.Tasks.Task CompleteAsync (string lockToken);

abstract member CompleteAsync : string -> System.Threading.Tasks.Task
override this.CompleteAsync : string -> System.Threading.Tasks.Task

Public Function CompleteAsync (lockToken As String) As Task

Parameters

lockToken: String

The lock token of the corresponding message to complete.

Returns

Task

Implements

CompleteAsync(String)

Remarks

A lock token can be found in LockToken, only when ReceiveMode is set to PeekLock. This operation can only be performed on messages that were received by this client.

Applies to