MessageQueue.FormatName Property

Reference

Definition

Namespace:: System.Messaging

Assembly:: System.Messaging.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 property System::String ^ FormatName { System::String ^ get(); };

[System.Messaging.MessagingDescription("MQ_FormatName")]
public string FormatName { get; }

[<System.Messaging.MessagingDescription("MQ_FormatName")>]
member this.FormatName : string

Public ReadOnly Property FormatName As String

Property Value

String

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

Attributes: MessagingDescriptionAttribute

Exceptions

MessageQueueException

The Path is not set.

-or-

An error occurred when accessing a Message Queuing method.

Examples

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);

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 and direct format name	Yes
Remote computer	Yes
Remote computer and direct format name	Yes

Applies to

Del via