Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This method checks recursively whether an object is current.

Syntax 

HRESULT IsUpToDate();

Parameters

None.

Return Value

One of the values 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 IsUpToDatemethod provides a way for containers to check recursively whether 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 updating the object.

To avoid lengthy queries of this type, make sure IsUpToDatereturns OLE_E_UNAVAILABLE.

When the object to be queried is small and contains no objects itself, which makes an efficient query possible, this method can return either S_OK or S_FALSE.

Requirements

Header Oleidl.h, oleidl.idl
Library oleaut32.lib, uuid.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also