Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

MessageQueue.Purge Method

.NET Framework 2.0

Deletes all the messages contained in the queue.

Namespace: System.Messaging
Assembly: System.Messaging (in system.messaging.dll)

C#
C++
VB
Copy 
public void Purge ()
J#
Copy 
public void Purge ()
JScript
Copy 
public function Purge ()
Exception type Condition

MessageQueueException

An error occurred when accessing a Message Queuing method.

Purging the queue causes Message Queuing to set the queue modification flag, which affects the LastModifyTime property. Messages that are purged from the queue are lost; they are not sent to the dead-letter queue or the journal queue.

The following table shows whether this method is available in various Workgroup modes.

Workgroup mode

Available

Local computer

Yes

Local computer and direct format name

Yes

Remote computer

No

Remote computer and direct format name

Yes

The following code example demonstrates the use of Purge.

C#
C++
Copy 

// Connect to a queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");

// Delete all messages from the queue.
queue.Purge();
J#
Copy 
// Connect to a queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");
// Delete all messages from the queue.
queue.Purge();
  • Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see .

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ