This topic has not yet been rated - Rate this topic

MessageQueue.Label Property

.NET Framework 4.5

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 ("").

Exceptions

Exception	Condition
ArgumentException	The label was set to an invalid value.
MessageQueueException	An error occurred when accessing a Message Queuing method.

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

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

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

MessageQueue Class

System.Messaging Namespace

Path

FormatName

GetPublicQueues

GetMessageQueueEnumerator

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)