Edit

Share via


MessagePropertyFilter.Id Property

Definition

Gets or sets a value that indicates whether to retrieve Id property information when receiving or peeking a message.

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

Property Value

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

Attributes

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

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

Product Versions
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

See also