Edit

Share via


Message.Label Property

Definition

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

public:
 property System::String ^ Label { System::String ^ get(); void set(System::String ^ value); };
[System.Messaging.MessagingDescription("MsgLabel")]
public string Label { get; set; }
[<System.Messaging.MessagingDescription("MsgLabel")>]
member this.Label : string with get, set
Public Property Label As String

Property Value

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

Attributes

Exceptions

The message queue is filtered to ignore the Label property.

Examples

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

Remarks

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.

Applies to

See also