Home Library Learn Downloads Support Community
Sign in | United States - English | |
0 out of 58 rated this helpful - Rate this topic

MessageQueue.FormatName Property

.NET Framework 2.0

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

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

C#
C++
VB
Copy 
public string FormatName { get; }
J#
Copy 
/** @property */
public String get_FormatName ()
JScript
Copy 
public function get FormatName () : String

Property Value

The name for the queue, which is unique on the network.
Exception type 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

The following code example displays the value of a message queue's FormatName property.

C#
Copy 
// Display the value of the queue's FormatName property.
Console.WriteLine("MessageQueue.FormatName: {0}", queue.FormatName);
J#
Copy 
// Display the value of the queue's FormatName property.
Console.WriteLine("MessageQueue.FormatName: {0}", 
    queue.get_FormatName());
  • Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see .

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ