This documentation is archived and is not being maintained.

MessageQueue.FormatName Property

Gets the unique queue name that Message Queuing generated at the time of the queue's creation.

[Visual Basic]
Public ReadOnly Property FormatName As String
[C#]
public string FormatName {get;}
[C++]
public: __property String* get_FormatName();
[JScript]
public function get FormatName() : String;

Property Value

The name for the queue, which is unique on the network.

Exceptions

Exception Type Condition
MessageQueueException The Path is not set.

-or-

An error occurred when accessing a Message Queuing API.

Remarks

The FormatName property contains the format name of the queue. Message Queuing uses the format name to identify which queue to open and how to access it. Unlike most of a queue's characteristics, the format name is not a Message Queuing application queue property, so you cannot access it through the Message Queuing management tool. The format name is simply a unique name for the queue, which Message Queuing generates when it creates the queue or which the application generates later.

If you specify a path using the path name syntax (such as myComputer\myQueue) rather than using the format name syntax when you read or write to the queue, the primary domain controller (which uses Active Directory) translates the Path into the associated FormatName before accessing the queue. If your application is working offline, you must use the format name syntax; otherwise, the primary domain controller will not be available to perform the path translation.

The following table shows whether this property is available in various Workgroup modes.

Workgroup Mode Available
Local computer Yes
Local computer + direct format name Yes
Remote computer Yes
Remote computer + direct format name Yes

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

MessageQueue Class | MessageQueue Members | System.Messaging Namespace | Path | Label | MessageQueue

Show: