Share via


QueueClient.Purge Method

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

Purges the Queue.

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

Usage

    Dim instance As QueueClient

instance.Purge

Syntax

'Declaration
Public Sub Purge
public void Purge ()
public:
void Purge ()
public void Purge ()
public function Purge ()

Remarks

This operation irrecoverably deletes all messages from the Queue.

The operation requires ‘Manage’ 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