Message.Extension Property

Definition

Gets or sets additional, application-defined information associated with the message.

public:
 property cli::array <System::Byte> ^ Extension { cli::array <System::Byte> ^ get(); void set(cli::array <System::Byte> ^ value); };
[System.Messaging.MessagingDescription("MsgExtension")]
public byte[] Extension { get; set; }
[<System.Messaging.MessagingDescription("MsgExtension")>]
member this.Extension : byte[] with get, set
Public Property Extension As Byte()

Property Value

Byte[]

An array of byte values that provides application-defined information associated with the message. The default is a zero-length array.

Attributes

Exceptions

The message queue is filtered to ignore the Extension property.

The Extension property is null.

Remarks

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

Where possible, you should include message data in the Body property of the message rather than the Extension property.

When working with foreign queues, use the Extension property to specify message properties that do not exist in Message Queuing.

A foreign queue exists in a queuing system other than Microsoft Message Queuing. Message Queuing communicates with such queues through a connector application.

Applies to

See also