OleCreateLinkFromData
Creates a
linked object from a data transfer object retrieved either from the clipboard
or as part of an OLE drag-and-drop operation.
WINOLEAPI OleCreateLinkFromData(
|
LPDATAOBJECT pSrcDataObj, |
//Pointer to data transfer objectt |
|
REFIID riid, |
//Reference to the identifier of the interface to be
used to communicate with the new object |
|
DWORD renderopt, |
//OLERENDER value |
|
LPFORMATETC pFormatEtc, |
//Pointer to a FORMATETC structure |
|
LPOLECLIENTSITE pClientSite, |
//Pointer to an interface |
|
LPSTORAGE pStg, |
//Pointer to the object storage |
|
LPVOID FAR*
ppvObj |
//Indirect pointer to requested object |
|
); |
|
Parameters
pSrcDataObj
[in] Pointer
to the IDataObject interface on the data transfer object from which the
linked object is to be created.
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).
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.
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.
pClientSite
[in] Pointer
to an instance of IOleClientSite, the primary interface through which
the object will request services from its container. May be NULL.
pStg
[in] Pointer
to the IStorage
interface on the storage object. This parameter may not be NULL.
ppvObj
[out]
Indirect pointer to the interface requested in riid on the newly created
object on return.
Return Values
S_OK
The linked
object was created successfully.
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