MessageQueue::Delete Method (String^)
Deletes a queue on a Message Queuing server.
Assembly: System.Messaging (in System.Messaging.dll)
Parameters
- path
-
Type:
System::String^
The location of the queue to be deleted.
| Exception | Condition |
|---|---|
| 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.dll> #using <system.messaging.dll> using namespace System; using namespace System::Messaging; int 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 0; }
Available since 1.1