Export (0) Print
Expand All

OleCreateLink function

Creates an OLE compound-document linked object.

Syntax


HRESULT OleCreateLink(
  _In_   LPMONIKER pmkLinkSrc,
  _In_   REFIID riid,
  _In_   DWORD renderopt,
  _In_   LPFORMATETC lpFormatEtc,
  _In_   LPOLECLIENTSITE pClientSite,
  _In_   LPSTORAGE pStg,
  _Out_  LPVOID *ppvObj
);

Parameters

pmkLinkSrc [in]

Pointer to the IMoniker interface on the moniker that can be used to locate the source of the linked object.

riid [in]

Reference to the identifier of the 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]

Specifies a 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 Remarks section below.

lpFormatEtc [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 lpFormatEtc parameter.

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.

pStg [in]

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

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.

Return value

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

Return codeDescription
OLE_E_CANT_BINDTOSOURCE

Not able to bind to source.

 

Remarks

Call OleCreateLink to allow a container to create a link to an object.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Ole2.h

Library

Ole32.lib

DLL

Ole32.dll

See also

IOleObject::SetMoniker
IOleClientSite::GetMoniker

 

 

Community Additions

ADD
Show:
© 2014 Microsoft