QueueClient.PeekLock Method ()

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

Retrieves a message from the queue using the Peek/Lock methodology.

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

Usage

    Dim instance As QueueClient
Dim returnValue As Message

returnValue = instance.PeekLock

Syntax

'Declaration
Public Function PeekLock As Message
public Message PeekLock ()
public:
Message^ PeekLock ()
public Message PeekLock ()
public function PeekLock () : Message

Return Value

Returns a Message that contains the locked message.

Example

Message message = queueClient.PeekLock();
string content = message.GetBody<string>();
queueClient.DeleteLockedMessage(message);

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