IEmptyVolumeCache::P urge メソッド (emptyvc.h)

  • [アーティクル]

不要なファイルの削除を開始するようにハンドラーに通知します。

構文

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

パラメーター

[in] dwlSpaceToFree

種類: DWORDLONG

ハンドラーが解放する必要があるディスク領域の量。 このパラメーターが -1 に設定されている場合、ハンドラーはすべてのファイルを削除する必要があります。

[in] picb

種類: IEmptyVolumeCacheCallback*

ディスク クリーンアップ マネージャーの IEmptyVolumeCacheCallBack インターフェイスへのポインター。 このポインターを使用して、インターフェイスの PurgeProgress メソッドを呼び出して、操作の進行状況を報告できます。

戻り値

種類: HRESULT

このメソッドは、これらの値のいずれかを返すことができます。

リターン コード 説明
S_OK
 正常終了しました。
E_ABORT
 操作は途中で終了しました。 この値は通常、 PurgeProgress が E_ABORTを返すときに返されます。 これは通常、ユーザーがディスク クリーンアップ マネージャーの [キャンセル] ボタンをクリックして操作を 取り消 したときに発生します。

解説

Windows 98 の場合、 dwSpaceToFree パラメーターは、 IEmptyVolumeCache::GetSpaceUsed が呼び出されたときにハンドラーによって指定された値に常に設定されます。

一般に、ハンドラーは単純に保ち、この関数が呼び出されたときにすべてのファイルを削除する必要があります。 ファイルの一部のみを削除することに大きなパフォーマンス上の利点がある場合、ハンドラーは ShowProperties メソッドを実装する必要があります。 このメソッドを呼び出すと、ユーザーが削除するファイルを選択できる UI が表示されます。

要件

   
サポートされている最小のクライアント Windows 2000 Professional、Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー emptyvc.h
[DLL] Shell32.dll (バージョン 5.0 以降)