# OleCreateLinkToFile

Creates an object that is linked to a file.

WINOLEAPI OleCreateLinkToFile(

LPWSTR lpszFileName, | //Pointer to source of linked object
REFIID riid, | //Reference to the identifier of the interface to be used to communicate with the new object
DWORD renderopt, | //Value from OLERENDER
LPFORMATETC pFormatEtc, | //Pointer to a FORMATETC structure
IOleClientSite * pClientSite, | //Pointer to an interface
IStorage * pStg, | //Pointer to the object’s storage
void ** ppvObj | //Indirect pointer to the interface requested in riid
); |

Parameters

lpszFileName
  [in] Pointer to a string naming the source file to be linked to.
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] 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 object was created successfully.
STG_E_FILENOTFOUND
  The file name is invalid.
OLE_E_CANT_BINDTOSOURCE
  Not able to bind to source.

Remarks

The OleCreateLinkToFile function differs from the OleCreateLink function because it can create links both to files that are not aware of OLE, as well as to those that are using the Windows Packager.

See Also

OleCreateLink