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

IOleObject::IsUpToDate method

Checks whether an object is up to date.

Syntax


HRESULT IsUpToDate();

Parameters

This method has no parameters.

Return value

This method returns S_OK if the object is up to date; otherwise, S_FALSE. Other possible return values include the following.

Return codeDescription
OLE_E_UNAVAILABLE

The status of object cannot be determined in a timely manner.

 

Remarks

The IOleObject::IsUpToDate method 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.

Notes to Implementers

Because of the recursive nature of IOleObject::IsUpToDate, determining whether an object is out-of-date, particularly one containing 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 IOleObject::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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OleIdl.h

IDL

OleIdl.Idl

IID

IID_IOleObject is defined as 00000112-0000-0000-C000-000000000046

See also

IOleObject
IOleObject::Update

 

 

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

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.