MessageQueue.Label Property

 

Gets or sets the queue description.

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

[MessagingDescriptionAttribute("MQ_Label")]
public string Label { get; set; }

Property Value

Type: System.String

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

Exception Condition
ArgumentException

The label was set to an invalid value.

MessageQueueException

An error occurred when accessing a Message Queuing method.

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

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

.NET Framework
Available since 1.1
Return to top
Show: