MessageQueue.Purge Method
Assembly: System.Messaging (in system.messaging.dll)
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.
// Connect to a queue on the local computer. MessageQueue queue = new MessageQueue(".\\exampleQueue"); // Delete all messages from the queue. queue.Purge();
// Connect to a queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");
// Delete all messages from the queue.
queue.Purge();
Windows 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.