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
)
public static void Delete (
	String path
)
public static function Delete (
	path : String
)
Not applicable.

Parameters

path

The location of the queue to be deleted.

Exception typeCondition

ArgumentException

The path parameter is a null reference (Nothing in Visual Basic) 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;
		}

	}
}

package MyProject;

import System.*;
import System.Messaging.*;

/// <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(String[] args)
    {
        // Determine whether the queue exists.
        if (MessageQueue.Exists(".\\myQueue")) {
            try {
                // Delete the queue.
                MessageQueue.Delete(".\\myQueue");
            }
            catch (MessageQueueException e) {
                if (e.get_MessageQueueErrorCode().
                    Equals(MessageQueueErrorCode.AccessDenied)) {
                    Console.WriteLine("Access is denied. "
                        + "Queue might be a system queue.");
                }
                // Handle other sources of MessageQueueException.
            }
        }        
        return;
    } //main
} //MyNewQueue 

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.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft