Deletes a queue on a Message Queuing server.
Namespace: System.Messaging
Assembly: System.Messaging (in system.messaging.dll)
'Usage
Dim path As String
MessageQueue.Delete(path)
'Declaration
Public Shared Sub Delete ( _
path As String _
)
public static void Delete (
String path
)
Parameters
- path
The location of the queue to be deleted.
| Exception type | Condition |
|---|
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.
Imports System
Imports System.Messaging
Public Class MyNewQueue
' Provides an entry point into the application.
'
' This example verifies existence and attempts to
' delete a queue.
Public Shared Sub Main()
' Determine whether the queue exists.
If MessageQueue.Exists(".\myQueue") Then
Try
' Delete the queue.
MessageQueue.Delete(".\myQueue")
Catch e As MessageQueueException
If e.MessageQueueErrorCode = _
MessageQueueErrorCode.AccessDenied Then
Console.WriteLine("Access is denied. " _
+ "Queue might be a system queue.")
End If
' Handle other sources of exceptions as necessary.
End Try
End If
Return
End Sub 'Main
End Class 'MyNewQueue
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
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see .
Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
.NET Framework
Supported in: 2.0, 1.1, 1.0
.NET Compact Framework
Supported in: 2.0