MessageQueue.Purge Method

Definition

Namespace:

System.Messaging

Assembly:

System.Messaging.dll

Deletes all the messages contained in the queue.

public:
 void Purge();

public void Purge ();

member this.Purge : unit -> unit

Public Sub Purge ()

Exceptions

MessageQueueException

An error occurred when accessing a Message Queuing method.

Examples

The following code example demonstrates the use of Purge.

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

// Delete all messages from the queue.
queue->Purge();

queue->Close();

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

// Delete all messages from the queue.
queue.Purge();

Remarks

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

See also

• Close()
• Refresh()