IOleObject::IsUpToDate

Article
06/30/2006

This method checks recursively whether or not an object is current.

HRESULT IsUpToDate();

Parameters

None.

Return Values

One of the values described in the following table is returned.

Value	Description
S_OK	Object is up to date.
S_FALSE	Object is not up to date.
OLE_E_UNAVAILABLE	Status of object cannot be determined in a timely manner.

Remarks

The IsUpToDate method provides a way for containers to check recursively whether or not all objects are up to date. That is, when the container calls this method on the first object, the object in turn calls it for all its own objects, and they in turn for all of theirs, until all objects have been checked.

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

Notes to Implementers

Because of the recursive nature of IsUpToDate, determining whether an object is out-of-date, particularly one that contains one or more other objects, can be as time-consuming as simply updating the object in the first place. If you would rather avoid lengthy queries of this type, make sure that IsUpToDate returns OLE_E_UNAVAILABLE. In cases where the object to be queried is small and contains no objects itself, thereby making an efficient query possible, this method can return either S_OK or S_FALSE.

Requirements

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

Share via