Export (0) Print
Expand All

MessageQueue.Delete Method

Deletes a queue on a Message Queuing server.

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

public static void Delete(
	string path
)

Parameters

path
Type: System.String

The location of the queue to be deleted.

ExceptionCondition
ArgumentException

The path parameter is null or is an empty string ("").

MessageQueueException

The syntax for the path parameter is not valid.

-or-

An error occurred when accessing a Message Queuing method.

The syntax for the path parameter depends on the type of queue.

Queue type

Syntax

Public queue

MachineName\QueueName

Private queue

MachineName\Private$\QueueName

For more syntax, see the Path property.

Alternatively, you can use the FormatName or Label to describe the queue path.

Reference

Syntax

Format name

FormatName:[ format name ]

Label

Label:[ label ]

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

No

The following code example deletes a Message Queuing queue, if it exists.

using System;
using System.Messaging;

namespace MyProject
{
	/// <summary> 
	/// Provides a container class for the example. 
	/// </summary> 
	public class MyNewQueue
	{

		//************************************************** 
		// Provides an entry point into the application. 
		//		  
		// This example verifies existence and attempts to  
		// delete a queue. 
		//************************************************** 

		public static void Main()
		{

			// Determine whether the queue exists. 
			if (MessageQueue.Exists(".\\myQueue"))
			{
				try
				{
					// Delete the queue.
					MessageQueue.Delete(".\\myQueue");
				}
				catch(MessageQueueException e)
				{
					if(e.MessageQueueErrorCode == 
						MessageQueueErrorCode.AccessDenied)
					{
						Console.WriteLine("Access is denied. " + 
							"Queue might be a system queue.");
					}

					// Handle other sources of MessageQueueException.
				}

			}
		
			return;
		}

	}
}

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, 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.

Show:
© 2014 Microsoft