TextBodyPart Property

Topic Last Modified: 2006-12-01

Returns a body part object containing the text content of this message. This property is read-only.

Applies To

IMessage Interface

Type Library

Microsoft CDO for Exchange 2000 Library

DLL Implemented In

CDOEX.DLL

Syntax

Property TextBodyPart As IBodyPart

HRESULT get_TextBodyPart(IBodyPart** pVal);

Parameters

Remarks

The TextBodyPart property can be used to quickly access the IBodyPart Interface on the body part object that contains the text portion of the message (if any). That is, rather than having to enumerate the body part hierarchy of the message seeking the object with Content-Type set to "text/plain", you can use TextBodyPart to return a reference immediately. A similar mechanism is available for the text/html portion of the message (if any) using the IMessage HTMLBody Property and the HTMLBodyPart Property.

The content of the BodyPart object referenced by TextBodyPart can be updated using the IMessage TextBody Property. The TextBody Property can only be used to update the contents, not the mail headers themselves.

If the requested body part does not exist, the method returns an error.