Método IEmptyVolumeCache::P urge (emptyvc.h)

Notifica al controlador que empiece a eliminar sus archivos innecesarios.

Sintaxis

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

Parámetros

[in] dwlSpaceToFree

Tipo: DWORDLONG

Cantidad de espacio en disco que debe liberar el controlador. Si este parámetro se establece en -1, el controlador debe eliminar todos sus archivos.

[in] picb

Tipo: IEmptyVolumeCacheCallback*

Puntero a la interfaz IEmptyVolumeCacheCallBack del administrador de limpieza de disco. Este puntero se puede usar para llamar al método PurgeProgress de la interfaz para informar sobre el progreso de la operación.

Valor devuelto

Tipo: HRESULT

Este método puede devolver uno de estos valores.

Código devuelto	Descripción
S_OK	Correcto.
E_ABORT	La operación finalizó prematuramente. Este valor se devuelve normalmente cuando PurgeProgress devuelve E_ABORT. Esto suele ocurrir cuando el usuario cancela la operación haciendo clic en el botón Cancelar del administrador de limpieza de disco.

Comentarios

Para Windows 98, el parámetro dwSpaceToFree siempre se establece en el valor especificado por el controlador cuando se llamó a IEmptyVolumeCache::GetSpaceUsed .

En general, los controladores deben ser simples y eliminar todos sus archivos cuando se llama a esta función. Si hay importantes ventajas de rendimiento para eliminar solo una parte de los archivos, el controlador debe implementar el método ShowProperties . Cuando se llama, este método muestra una interfaz de usuario que permite al usuario seleccionar los archivos que se van a eliminar.

Requisitos

Cliente mínimo compatible	Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	emptyvc.h
Archivo DLL	Shell32.dll (versión 5.0 o posterior)