nf-ole2-olecreatelinkfromdata.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:ole2.OleCreateLinkFromData	OleCreateLinkFromData function (ole2.h)	Creates a linked object from a data transfer object retrieved either from the clipboard or as part of an OLE drag-and-drop operation.	OleCreateLinkFromData OleCreateLinkFromData function [COM] _ole_OleCreateLinkFromData com.olecreatelinkfromdata ole2/OleCreateLinkFromData	com\olecreatelinkfromdata.htm	com	3eda0cf5-c33d-43cf-ba8a-02a4f6383adc	12/05/2018	OleCreateLinkFromData, OleCreateLinkFromData function [COM], _ole_OleCreateLinkFromData, com.olecreatelinkfromdata, ole2/OleCreateLinkFromData	ole2.h		Windows	Windows 2000 Professional [desktop apps only]	Windows 2000 Server [desktop apps only]										Ole32.lib	Ole32.dll		Windows			19H1	OleCreateLinkFromData ole2/OleCreateLinkFromData	c++	APIRef kbSyntax	DllExport	Ole32.dll	OleCreateLinkFromData

OleCreateLinkFromData function

-description

Creates a linked object from a data transfer object retrieved either from the clipboard or as part of an OLE drag-and-drop operation.

-parameters

-param pSrcDataObj [in]

Pointer to the IDataObject interface on the data transfer object from which the linked object is to be created.

-param riid [in]

Reference to the identifier of interface the caller later uses to communicate with the new object (usually IID_IOleObject, defined in the OLE headers as the interface identifier for IOleObject).

-param renderopt [in]

Value from the enumeration OLERENDER that indicates the locally cached drawing or data-retrieval capabilities the newly created object is to have. Additional considerations are described in the following Remarks section.

-param pFormatEtc [in]

Pointer to a value from the enumeration OLERENDER that indicates the locally cached drawing or data-retrieval capabilities the newly created object is to have. The OLERENDER value chosen affects the possible values for the pFormatEtc parameter.

-param pClientSite [in]

Pointer to an instance of IOleClientSite, the primary interface through which the object will request services from its container. This parameter can be NULL.

-param pStg [in]

Pointer to the IStorage interface on the storage object. This parameter cannot be NULL.

-param ppvObj [out]

Address of pointer variable that receives the interface pointer requested in riid. Upon successful return, ppvObj contains the requested interface pointer on the newly created object.

-returns

This function returns S_OK on success. Other possible values include the following.

Return code	Description
CLIPBRD_E_CANT_OPEN	Not able to open the clipboard.
OLE_E_CANT_GETMONIKER	Not able to extract the object's moniker.
OLE_E_CANT_BINDTOSOURCE	Not able to bind to source. Binding is necessary to get the cache's initialization data.

-remarks

The OleCreateLinkFromData function is used to implement either a paste-link or a drag-link operation. Its operation is similar to that of the OleCreateFromData function, except that it creates a link, and looks for different data formats. If the CF_LINKSOURCE format is not present, and either the FileName or FileNameW clipboard format is present in the data transfer object, OleCreateLinkFromData creates a package containing the link to the indicated file.

You use the renderopt and pFormatetc parameters to control the caching capability of the newly created object. For general information on how to determine what is to be cached, refer to the OLERENDER enumeration for a description of the interaction between renderopt and pFormatetc. There are, however, some additional specific effects of these parameters on the way OleCreateLinkFromData initializes the cache, as follows.

Value	Description
OLERENDER_DRAW, OLERENDER_FORMAT	If the presentation information is in the other formats in the source data object, this information is used. If the information is not present, the cache is initially empty, but will be filled the first time the object is run. No other formats are cached in the newly created object.
OLERENDER_NONE, OLERENDER_ASIS	Nothing is to be cached in the newly created object.

-see-also

OleCreateLink