Export (0) Print
Expand All

MessageQueue.Exists Method

Determines whether a Message Queuing queue exists at the specified path.

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

public static bool Exists(
	string path
)

Parameters

path
Type: System.String

The location of the queue to find.

Return Value

Type: System.Boolean
true if a queue with the specified path exists; otherwise, false.

ExceptionCondition
ArgumentException

The path syntax is not valid.

MessageQueueException

An error occurred when accessing a Message Queuing method.

-or-

The Exists(String) method is being called on a remote private queue

InvalidOperationException

The application used format name syntax when verifying queue existence.

The Exists(String) method determines whether a Message Queuing queue exists at a specified path. No method exists to determine whether a queue with a specified format name exists. For more information about the format name syntax and other path syntax forms, see the Path property.)

Exists(String) is an expensive operation. Use it only when it is necessary within the application.

NoteNote

The Exists(String) method does not support the FormatName prefix.

The syntax for the path parameter depends on the type of queue, as shown in the following table.

Queue type

Syntax

Public queue

MachineName\QueueName

Exists(String) cannot be called to verify the existence of a remote private queue.

For more syntax, see the Path property.

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

Reference

Syntax

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

No

Remote computer

No

Remote computer and direct format name

No

The following code example verifies whether a Message Queuing queue exists, and then deletes it.

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, 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