Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

OleCreateLinkToFile function

Creates an object that is linked to a file.

Syntax


HRESULT OleCreateLinkToFile(
  _In_   LPCOLESTR lpszFileName,
  _In_   REFIID riid,
  _In_   DWORD renderopt,
  _In_   LPFORMATETC lpFormatEtc,
  _In_   LPOLECLIENTSITE pClientSite,
  _In_   LPSTORAGE pStg,
  _Out_  LPVOID *ppvObj
);

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.

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 pFormatEtc 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
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.

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

OleCreateLink

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.