IOleCache2::UpdateCache method (oleidl.h)
Updates the specified caches. This method is used when the application needs precise control over caching.
HRESULT UpdateCache(
[in] LPDATAOBJECT pDataObject,
[in] DWORD grfUpdf,
[in] LPVOID pReserved
);
[in] pDataObject
A pointer to the IDataObject interface on the data object from which the cache is updated. Object handlers and in-process servers typically pass a non-NULL value. A container application usually passes NULL, and the source is obtained from the currently running object.
[in] grfUpdf
The type of cache to be updated. This parameter can be one or more of the following values.
Value | Meaning |
---|---|
|
Updates caches created by using ADVF_NODATA in the call to IOleCache::Cache. |
|
Updates caches created by using ADVFCACHE_ONSAVE in the call to IOleCache::Cache. |
|
Updates caches created by using ADVFCACHE_ONSTOP in the call to IOleCache::Cache. |
|
Dynamically updates the caches (as is normally done when the object sends out OnDataChange notices). |
|
Updates the cache if blank, regardless of any other flag specified. |
|
Updates only caches that are blank. |
|
The equivalent of using an OR operation to combine UPDFCACHE_IFBLANK and UPDFCACHE_ONSAVECACHE. |
|
Updates all caches. |
|
Updates all caches except those created with ADVF_NODATA in the call to IOleCache::Cache. Thus, you can control updates to the caches created with the ADVF_NODATA flag and only update these caches explicitly. |
[in] pReserved
This parameter is reserved and must be NULL.
This method returns S_OK on success. Other possible return values include the following.
Return code | Description |
---|---|
|
One of the arguments is not valid. |
|
An unexpected error has occurred. |
|
Insufficient memory is available for this operation. |
|
The specified pDataObject is not running. |
|
None of the caches were updated. |
|
Some of the caches were updated. |
Requirement | Value |
---|---|
Minimum supported client | Windows 2000 Professional [desktop apps only] |
Minimum supported server | Windows 2000 Server [desktop apps only] |
Target Platform | Windows |
Header | oleidl.h |