QueueClient.ReleaseLock Method

[This is prerelease documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Releases the lock on a message retrieved via PeekLock or PeekLockMultiple(Int32).

Namespace: Microsoft.ServiceBus
Assembly: Microsoft.ServiceBus (in microsoft.servicebus.dll)

Usage

    Dim instance As QueueClient
Dim message As Message

instance.ReleaseLock(message)

Syntax

'Declaration
Public Sub ReleaseLock ( _
    message As Message _
)

public void ReleaseLock (
    Message message
)

public:
void ReleaseLock (
    Message^ message
)

public void ReleaseLock (
    Message message
)

public function ReleaseLock (
    message : Message
)

Parameters

• message
  The message to unlock.

Remarks

By releasing the lock, the client indicates that it could not successfully process the message or that it is no interested in processing the message. The client is not obligated to release the lock as the message will be automatically restored into the Queue after the lock expires before the message is explicitly deleted. Calling this method will allow the message to become immediately available for retrieval again.

The operation requires ‘Listen’ permission on the Queue.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003 , Windows Server 2008, and Windows 2000

Target Platforms

See Also

Reference

QueueClient Class
QueueClient Members
Microsoft.ServiceBus Namespace