MessagePropertyFilter.Id 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 a value that indicates whether to retrieve Id property information when receiving or peeking a message.

public:
 property bool Id { bool get(); void set(bool value); };

[System.Messaging.MessagingDescription("MsgId")]
public bool Id { get; set; }

[<System.Messaging.MessagingDescription("MsgId")>]
member this.Id : bool with get, set

Public Property Id As Boolean

Property Value

Boolean

true to receive Id information; otherwise, false. The default is true.

Attributes: MessagingDescriptionAttribute

Examples

The following code example demonstrates the use of the Id property.

// Set the queue's MessageReadPropertyFilter property 
// to enable the message's Id property.
queue->MessageReadPropertyFilter->Id = true;

// Peek at the message. Time out after ten seconds 
// in case the message was not delivered.
orderMessage = queue->Peek(TimeSpan::FromSeconds(10.0));

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

// Set the queue's MessageReadPropertyFilter property to enable the
// message's Id property.
queue.MessageReadPropertyFilter.Id = true;

// Peek at the message. Time out after ten seconds in case the message
// was not delivered.
orderMessage = queue.Peek(TimeSpan.FromSeconds(10.0));

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

Remarks

The Id property of the Message class indicates the Message Queuing-generated unique identifier of the message. This identifier is generated when the message is sent.

Applies to

Deila með