This documentation is archived and is not being maintained.

Message.BodyStream Property

Gets or sets the information in the body of the message.

[Visual Basic]
Public Property BodyStream As Stream
[C#]
public Stream BodyStream {get; set;}
[C++]
public: __property Stream* get_BodyStream();
public: __property void set_BodyStream(Stream*);
[JScript]
public function get BodyStream() : Stream;
public function set BodyStream(Stream);

Property Value

A Stream that contains the serialized information included in the Body of the message.

Exceptions

Exception Type Condition
InvalidOperationException The message queue is filtered to ignore the Body property.

Remarks

The body of a message can consist of any type of information--for example, a string, a date, a currency, a number, an array of bytes, or any managed object. This information is serialized into a Stream to be passed to the queue.

Specify either the Body property or the BodyStream property before sending the Message object. If you set the Body property, the contents are serialized into the BodyStream property. However, you can choose to write the BodyStream property directly. This is useful, for example, when you want to open a connection to a file and stream its contents as the body of your message.

Unless you write the contents of the message directly to the BodyStream property, set the Formatter property before you send the message. When the Send method is called on the MessageQueue instance, the body is serialized using the formatter contained in the Formatter property. If you send the message without specifying a value for the Formatter property, the formatter defaults to XmlMessageFormatter.

If you set the UseEncryption property to true for the body of this message, the message will be encrypted when it is sent--not when you set the Body property. Therefore, the BodyStream property is never encrypted.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

Message Class | Message Members | System.Messaging Namespace | Message | Body | BodyType | Formatter | AppSpecific | Extension | UseEncryption | Send

Show: