IEmptyVolumeCache::Purge method (emptyvc.h)
Notifies the handler to start deleting its unneeded files.
HRESULT Purge( [in] DWORDLONG dwlSpaceToFree, [in] IEmptyVolumeCacheCallBack *picb );
The amount of disk space that the handler should free. If this parameter is set to -1, the handler should delete all its files.
This method can return one of these values.
||The operation was ended prematurely. This value is usually returned when PurgeProgress returns E_ABORT. This typically happens when the user cancels the operation by clicking the disk cleanup manager's Cancel button.|
For Windows 98, the dwSpaceToFree parameter is always set to the value specified by the handler when IEmptyVolumeCache::GetSpaceUsed was called.
In general, handlers should be kept simple and delete all of their files when this function is called. If there are significant performance advantages to only deleting a portion of the files, the handler should implement the ShowProperties method. When called, this method displays a UI that allows the user to select the files to be deleted.
|Minimum supported client||Windows 2000 Professional, Windows XP [desktop apps only]|
|Minimum supported server||Windows Server 2003 [desktop apps only]|
|DLL||Shell32.dll (version 5.0 or later)|