MessageQueueInstaller.Path Property

Definition

Namespace:

System.Messaging

Assembly:

System.Messaging.dll

Gets or sets the location of the queue that is referenced by this object.

public:
 property System::String ^ Path { System::String ^ get(); void set(System::String ^ value); };

[System.ComponentModel.TypeConverter("System.Diagnostics.Design.StringValueConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
public string Path { get; set; }

[<System.ComponentModel.TypeConverter("System.Diagnostics.Design.StringValueConverter, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>]
member this.Path : string with get, set

Public Property Path As String

Property Value

String

The path that represents the location of the queue in the network.

Attributes

TypeConverterAttribute

Exceptions

ArgumentException

The Path was set to an invalid value, possibly because the syntax is not valid.

-or-

The Path is null.

Remarks

The syntax for the Path property depends on the type of queue it references. The following table shows the syntax you should use for queues of various types.

Queue type	Syntax
Public queue	machineName\queueName
Private queue	machineName\Private$\queueName
Journal queue	machineName\queueName\Journal$
Machine journal queue	machineName\Journal$
Machine dead-letter queue	machineName\Deadletter$
Machine transactional dead-letter queue	machineName\XactDeadletter$

Use "." for the local computer.

You can also use the FormatName or Label of a Message Queuing application object to describe the queue path. The following table shows the proper syntax for each type of reference.

Reference	Syntax
Format name	FormatName:[ format name ]
Label	Label:[ label ]

If you are working offline, you must use the format name to define the queue Path. If you do not, the application will throw an exception, because the primary domain controller is unavailable to resolve the Path into the FormatName.