Index   Commented   Search   About

IOleCache2::UpdateCache

Updates specified cache(s). It updates the cache according to the value of a parameter. This method is used when the application needs precise control over caching.

HRESULT UpdateCache(

IDataObject * pDataObject,
//Points to the data object from which the cache is updated
DWORD grfUpdt,
//Specifies the type of cache to update
LPVOID pReserved
//Reserved, must be NULL
);

Parameters

pDataObject

[in]Points to 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.

grfUpdt

Specifies the type of cache to update. The value is obtained by combining values from the following table:

Cache Control Values
Description
UPDFCACHE_NODATACACHE
Updates caches created by using ADVF_NODATA in the call to IOleCache::Cache.
UPDFCACHE_ONSAVECACHE
Updates caches created by using ADVFCACHE_ONSAVE in the call to IOleCache::Cache.
UPDFCACHE_ONSTOPCACHE
Updates caches created by using ADVFCACHE_ONSTOP in the call to IOleCache::Cache.
UPDFCACHE_NORMALCACHE
Dynamically updates the caches (as is normally done when the object sends out OnDataChange notices).
UPDFCACHE_IFBLANK
Updates the cache if blank, regardless of any other flag specified.
UPDFCACHE_ONLYIFBLANK
Updates only caches that are blank.
UPDFCACHE_
IFBLANKORONSAVECACHE
The equivalent of using an OR operation to combine UPDFCACHE_IFBLANK and UPDFCACHE_ONSAVECACHE.
UPDFCACHE_ALL
Updates all caches.
UPDFCACHE_
ALLBUTNODATACACHE
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.

pReserved

Reserved for future use; must be NULL.

Return Values

S_OK

The cache(s) were updated according to the value specified in grfUpdt.

E_OUTOFMEMORY

The cache(s) were not updated due to a lack of memory.

E_INVALIDARG

One or more arguments are invalid.

E_UNEXPECTED

An unexpected error occurred.

OLE_E_NOTRUNNING

The specified pDataObject is not running.

CACHE_E_NOCACHE_UPDATED

None of the caches were updated.

CACHE_S_SOMECACHES_NOTUPDATED

Some of the caches were updated.

See Also

IOleCache, IOleCacheControl

Related Links

Software for Delphi and C++ Builder developers
Software for Visual Studio .NET developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET
TMS Scripter Studio Pro components for Delphi/C++Builder

More Online Helps

Win32 Programmer's Reference (win32.hlp)
Win32 Multimedia Programmer's Reference (mmedia.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (sock2.hlp)
Unix Manual Pages

Free Tech Secrets ;) Copyright © 2008 Free Tect Secrets ;) greatis just4fun network just4fun