IEmptyVolumeCache::Purge method (emptyvc.h)

Notifies the handler to start deleting its unneeded files.

Syntax

HRESULT Purge(
  [in] DWORDLONG                 dwlSpaceToFree,
  [in] IEmptyVolumeCacheCallBack *picb
);

Parameters

[in] dwlSpaceToFree

Type: DWORDLONG

The amount of disk space that the handler should free. If this parameter is set to -1, the handler should delete all its files.

[in] picb

Type: IEmptyVolumeCacheCallback*

A pointer to the disk cleanup manager's IEmptyVolumeCacheCallBack interface. This pointer can be used to call the interface's PurgeProgress method to report on the progress of the operation.

Return value

Type: HRESULT

This method can return one of these values.

Remarks

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.

Requirements