MessageQueue.FormatName Property
Gets the unique queue name that Message Queuing generated at the time of the queue's creation.
Assembly: System.Messaging (in System.Messaging.dll)
| Exception | Condition |
|---|---|
| MessageQueueException |
The Path is not set. -or- An error occurred when accessing a Message Queuing method. |
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 and direct format name |
Yes |
|
Remote computer |
Yes |
|
Remote computer and direct format name |
Yes |
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
