MessagePropertyFilter.Extension Property

Definition

Namespace:

System.Messaging

Assembly:

System.Messaging.dll

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

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

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

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

Public Property Extension As Boolean

Property Value

Boolean

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

Attributes

MessagingDescriptionAttribute

Examples

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

// Set the queue's MessageReadPropertyFilter property 
// to enable the message's Extension property.
queue->MessageReadPropertyFilter->Extension = 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 Extension property.
Console::WriteLine("Message.Extension: {0}", 
    orderMessage->Extension);

// Set the queue's MessageReadPropertyFilter property to enable the
// message's Extension property.
queue.MessageReadPropertyFilter.Extension = 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 Extension property.
Console.WriteLine("Message.Extension: {0}",
    orderMessage.Extension);

Remarks

The Extension property of the Message class provides for additional application-defined information that is associated with the message, like a large binary object. It is the responsibility of the receiving application to interpret the contents of the Extension.

See also

• Extension
• DefaultExtensionSize
• MessageQueue