MessageQueue.Label 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 or sets the queue description.

public:
 property System::String ^ Label { System::String ^ get(); void set(System::String ^ value); };

[System.Messaging.MessagingDescription("MQ_Label")]
public string Label { get; set; }

[<System.Messaging.MessagingDescription("MQ_Label")>]
member this.Label : string with get, set

Public Property Label As String

Property Value

String

The label for the message queue. The default is an empty string ("").

Attributes: MessagingDescriptionAttribute

Exceptions

ArgumentException

The label was set to an invalid value.

MessageQueueException

An error occurred when accessing a Message Queuing method.

Examples

The following code example gets and sets the value of a message queue's Label property.

// Set the queue's Label property value.
queue.Label = "Example Queue";

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

Remarks

The maximum length of a message queue label is 124 characters.

The Label property does not need to be unique across all queues. However, if multiple queues share the same Label, you cannot use the Send(Object) method to broadcast a message to all of them. If you use the label syntax for the Path property when you send the message, an exception will be thrown if the Label is not unique.

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

Applies to

Share via