Skip to content

Latest commit

 

History

History
124 lines (90 loc) · 5.05 KB

nf-oleidl-iolelink-setupdateoptions.md

File metadata and controls

124 lines (90 loc) · 5.05 KB
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:oleidl.IOleLink.SetUpdateOptions
IOleLink::SetUpdateOptions (oleidl.h)
Specifies how often a linked object should update its cached data.
IOleLink interface [COM]
SetUpdateOptions method
IOleLink.SetUpdateOptions
IOleLink::SetUpdateOptions
SetUpdateOptions
SetUpdateOptions method [COM]
SetUpdateOptions method [COM]
IOleLink interface
_ole_iolelink_setupdateoptions
com.iolelink_setupdateoptions
oleidl/IOleLink::SetUpdateOptions
com\iolelink_setupdateoptions.htm
com
310c25b5-a2f6-4ed7-8673-c53809fad32f
12/05/2018
IOleLink interface [COM],SetUpdateOptions method, IOleLink.SetUpdateOptions, IOleLink::SetUpdateOptions, SetUpdateOptions, SetUpdateOptions method [COM], SetUpdateOptions method [COM],IOleLink interface, _ole_iolelink_setupdateoptions, com.iolelink_setupdateoptions, oleidl/IOleLink::SetUpdateOptions
oleidl.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
OleIdl.Idl
Windows
19H1
IOleLink::SetUpdateOptions
oleidl/IOleLink::SetUpdateOptions
c++
APIRef
kbSyntax
COM
OleIdl.h
IOleLink.SetUpdateOptions

IOleLink::SetUpdateOptions

-description

Specifies how often a linked object should update its cached data.

-parameters

-param dwUpdateOpt [in]

Specifies how often a linked object should update its cached data. The possible values for dwUpdateOpt are taken from the enumeration OLEUPDATE.

-returns

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

Return code Description
E_INVALIDARG
The supplied value is invalid.

-remarks

Notes to Callers

Your container application should call IOleLink::SetUpdateOptions when the end user changes the update option for a linked object.

The end user selects the update option for a linked object using the Links dialog box. If you use the OleUIEditLinks function to display this dialog box, you must implement the IOleUILinkContainer interface. The dialog box calls your IOleUILinkContainer::SetLinkUpdateOptions method to specify the update option chosen by the end user. Your implementation of this method should call the IOleLink::SetUpdateOptions method to pass the selected option to the linked object.

Notes to Implementers

The default update option is OLEUDPATE_ALWAYS. The linked object's implementation of IPersistStorage::Save saves the current update option.

If OLEUDPATE_ALWAYS is specified as the update option, the linked object updates the link's caches in the following situations:

  • When the update option is changed from manual to automatic, if the link source is running.
  • Whenever the linked object binds to the link source.
  • Whenever the link source is running and the linked object's IOleObject::Close, IPersistStorage::Save, or IAdviseSink::OnSave implementations are called.
For both manual and automatic links, the linked object updates the cache whenever the container application calls IOleObject::Update or IOleLink::Update.

-see-also

IOleLink

IOleLink::GetUpdateOptions

IOleLink::Update

IOleObject::Update

IOleUILinkContainer

OleUIEditLinks