COleClientItem::CreateLinkFromData

BOOL CreateLinkFromData( COleDataObject* pDataObject, OLERENDER render = OLERENDER_DRAW, CLIPFORMAT cfFormat = 0, LPFORMATETC lpFormatEtc = NULL );

Return Value

Nonzero if successful; otherwise 0.

Parameters

pDataObject

Pointer to the COleDataObject object from which the OLE item is to be created.

render

Flag specifying how the server will render the OLE item. For the possible values, see OLERENDER in the OLE documentation.

cfFormat

Specifies the Clipboard data format to be cached when creating the OLE item.

lpFormatEtc

Pointer to a FORMATETC structure used if render is OLERENDER_FORMAT or OLERENDER_DRAW. Provide a value for this parameter only if you want to specify additional format information beyond the Clipboard format specified by cfFormat. If you omit this parameter, default values are used for the other fields in the FORMATETC structure.

Remarks

Call this function to create a linked item from a COleDataObject object. Call this during a drop operation when the user indicates a link should be created. It can also be used to handle the Edit Paste command. It is called by the framework in COleClientItem::CreateLinkFromClipboard and in COlePasteSpecialDialog::CreateItem when the Link option has been selected.

For more information, see OleCreateLinkFromData, OLERENDER, and FORMATETC in the OLE documentation.

COleClientItem Overview | Class Members | Hierarchy Chart