IOleObject::Update

Article
06/30/2006

This method updates an object handler's or link object's data to view caches.

HRESULT Update();

Parameters

None.

Return Values

This method supports the standard return value E_FAIL, as well as the values described in the following table.

Value	Description
S_OK	All caches are up to date.
OLE_E_CANT_BINDTOSOURCE	Cannot run object to get updated data. The object is for some reason unavailable to the caller.
CACHE_E_NOCACHE_UPDATED	No caches were updated.
CACHE_S_SOMECACHES_NOTUPDATED	Some caches were not updated.

Remarks

The Update method provides a way for containers to keep data updated in their linked and embedded objects. A link object can become out-of-date if the link source has been updated. An embedded object that contains links to other objects can also become out of date. An embedded object that does not contain links cannot become out of date because its data is not linked to another source.

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Notes to Implementers

When a container calls a link object's Update method, the link object finds the link source and gets a new presentation from it. This process may also involve running one or more object applications, which could be time-consuming.

When a container calls an embedded object's Update method, it is requesting the object to update all link objects it may contain. In response, the object handler recursively calls Update for each of its own linked objects, running each one as needed.

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Oleidl.h, Oleidl.idl.
Link Library: Oleaut32.lib, Uuid.lib.

Share via