Platform SDK: DirectX

IDirectMusicLoader::ClearCache

The IDirectMusicLoader::ClearCache method tells the loader to release all references to a particular type of object.

HRESULT ClearCache(
  REFGUID rguidClass 
);

Parameters

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

Return Values

The method returns S_OK.

Remarks

This method clears all objects that are currently being held, but does not turn off caching. Use the IDirectMusicLoader::EnableCache method to turn off automatic caching.

To clear a single object from the cache, call the IDirectMusicLoader::ReleaseObject method.

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, Caching Objects