IDirectMusicLoader::EnableCache

The IDirectMusicLoader::EnableCache method tells the loader to enable or disable automatic caching of all objects it loads. By default, caching is enabled for all classes.

HRESULT EnableCache(
  REFGUID rguidClass,
  BOOL fEnable
);

Parameters

rguidClass

Reference to (C++) or address of (C) the identifier of the class of objects to cache. You can specify all types with GUID_DirectMusicAllTypes.

fEnable

TRUE to enable caching; FALSE to clear and disable.

Return Values

The method returns S_OK if the cache state is changed, or S_FALSE if the cache is already in the desired state.

Remarks

To clear the cache without disabling caching, call the IDirectMusicLoader::ClearCache method.

The following code example disables caching only for segment objects so that they do not stay in memory after the application releases them. Other objects that should be shared, such as styles, chord maps and DLS collections, continue to be cached. The first call to EnableCache would normally be unnecessary because caching is enabled for all objects by default.

void myPrepareLoader(IDirectMusicLoader *pILoader)
 
{
    pILoader->EnableCache(GUID_DirectMusicAllTypes, TRUE);
    pILoader->EnableCache(CLSID_DirectMusicSegment, FALSE);
}

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dmusici.h.

See Also

IDirectMusicLoader::CacheObject, IDirectMusicLoader::ClearCache, Caching Objects