This topic has not yet been rated - Rate this topic

MessageQueue.Purge Method

.NET Framework 4.5

Deletes all the messages contained in the queue.

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

public void Purge()

Exceptions

Exception	Condition
MessageQueueException	An error occurred when accessing a Message Queuing method.

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

Examples

The following code example demonstrates the use of Purge.

C++


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

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

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

MessageQueue Class

System.Messaging Namespace

Refresh

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)