Export (0) Print
Expand All

MessagePropertyFilter.Id Property

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

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

[MessagingDescriptionAttribute("MsgId")]
public bool Id { get; set; }

Property Value

Type: System.Boolean
true to receive Message.Id information; otherwise, false. The default is true.

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.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 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