Export (0) Print
Expand All

Message.Label Property

Gets or sets an application-defined Unicode string that describes the message.

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

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

Property Value

Type: System.String
The label of the message. The default is an empty string ("").

ExceptionCondition
InvalidOperationException

The message queue is filtered to ignore the Label property.

You can use a message label for several purposes. For example, you can use it for display purposes or to selectively process messages based on the label value. The label does not need to be unique across messages.

Message queue and message labels represent an application-defined value that can help identify the queue or message in human-readable terms. It is the responsibility of the application to interpret the label contents, which have no intrinsic meaning to the Message Queuing application.

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

// Set the message's Label property.
orderMessage.Label = "Order Message";

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

.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

Windows 8.1, Windows Server 2012 R2, 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.

Show:
© 2014 Microsoft