PidTagAttachRendering Canonical Property

  • Article

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Contains a Microsoft Windows metafile with rendering information for an attachment.

Associated properties:

PR_ATTACH_RENDERING

Identifier:

0x3709

Data type:

PT_BINARY

Area:

Message attachment

Remarks

The purpose of this property is to provide an icon or other pictorial representation that can be displayed within the parent message at the point of attachment. Such representation typically includes the name of the attachment, if any, and the nature of the attachment, such as a Microsoft Office Word document. A client application can use this representation in the display of the message.

For an attached file, this property usually portrays an icon for the file.

For an attached message, this property is typically not set. A client application needing to render an attached message should obtain its PR_MESSAGE_CLASS (PidTagMessageClass) property, call IMAPIFormMgr::ResolveMessageClass for a pointer to the corresponding form information object, open the IMAPIFormInfo interface on that object, and use GetProps to retrieve the PR_ICON (PidTagIcon) or PR_MINI_ICON (PidTagMiniIcon) property.

For an embedded static OLE object, this property contains a Microsoft Windows metafile that can be used to draw the attachment representation in a window.

For an embedded dynamic OLE object, the client should use the OLE data to generate the rendering information.

In all cases, the client application should be aware that this property is usually several hundred bytes in size and is subject to truncation in the attachment table. If a client wishes to render the attachment from this property without opening the attachment itself, it must work within the table truncation rule. For more information, see Working with Large Columns.

Protocol Specifications

Header Files

  • Mapidefs.h
    Provides data type definitions.

  • Mapitags.h
    Contains definitions of properties listed as alternate names.

See Also

Concepts

MAPI Properties

MAPI Canonical Properties

Mapping Canonical Property Names to MAPI Names

Mapping MAPI Names to Canonical Property Names