Share via


QueueClient.Retrieve Method ()

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

Retrieves the next message from the queue and deletes it from the Queue.

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

Usage

    Dim instance As QueueClient
Dim returnValue As Message

returnValue = instance.Retrieve

Syntax

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

Return Value

Returns a Message that contains the message.

Remarks

The method blocks until a message can be retrieved from the queue.

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