Edit

IEmptyVolumeCacheCallBack::ScanProgress method (emptyvc.h)

  • Article

Called by a disk cleanup handler to update the disk cleanup manager on the progress of a scan for deletable files.

Syntax

HRESULT ScanProgress(
  [in] DWORDLONG dwlSpaceUsed,
  [in] DWORD     dwFlags,
  [in] LPCWSTR   pcwszStatus
);

Parameters

[in] dwlSpaceUsed

Type: DWORDLONG

The amount of disk space that the handler can free at this point in the scan.

[in] dwFlags

Type: DWORD

A flag that can be sent to the disk cleanup manager. This flag can have the following value.

EVCCBF_LASTNOTIFICATION

This flag should be set if the handler will not call this method again. It is typically set when the scan is near completion.

[in] pcwszStatus

Type: LPCWSTR

Reserved.

Return value

Type: HRESULT

This method can return one of these values.

Return code Description
S_OK
 The handler should continue scanning for deletable files.
E_ABORT
 This value is returned when the user clicks the Cancel button on the disk cleanup manager's dialog box while a scan is in progress. The handler should stop scanning and shut down.

Remarks

This method is typically called by the handler's GetSpaceUsed method while the handler is scanning for deletable files.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header emptyvc.h
DLL Shell32.dll (version 5.0 or later)