MessageQueue.FormatName Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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)

[MessagingDescriptionAttribute("MQ_FormatName")]
public string FormatName { get; }

Property Value

Type: System.String

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

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

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

// Display the value of the queue's FormatName property.
Console.WriteLine("MessageQueue.FormatName: {0}", queue.FormatName);

.NET Framework
Available since 1.1
Return to top
Show: