IEmptyVolumeCacheCallBack
COM公式ドキュメント
ディスククリーンアップハンドラーがディスククリーンアップマネージャーと通信するために使用するメソッドを公開します。
解説(Remarks)
ディスククリーンアップハンドラーは、このインターフェイスを使用して、ファイルの削除または削除可能なファイルのスキャンの進行状況をディスククリーンアップマネージャーに報告します。また、ユーザーが操作をキャンセルしたかどうかを調べるためにマネージャーへ問い合わせる手段も提供します。ハンドラーは、マネージャーが IEmptyVolumeCache::GetSpaceUsed または IEmptyVolumeCache::Purge メソッドを呼び出すときに、このインターフェイスへのポインターを受け取ります。
メソッド 2
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
削除可能なファイルのスキャンの進行状況をディスククリーンアップマネージャーに更新するために、ディスククリーンアップハンドラーから呼び出されます。
| dwlSpaceUsed | ULONGLONG | in | スキャンのこの時点でハンドラーが解放できるディスク領域の量。 |
| dwFlags | DWORD | in | ディスククリーンアップマネージャーに送信できるフラグ。このフラグには次の値を指定できます。 EVCCBF_LASTNOTIFICATIONハンドラーがこのメソッドを再度呼び出さない場合は、このフラグを設定します。通常はスキャンが完了に近づいたときに設定されます。 |
| pcwszStatus | LPWSTR | in | 予約済み。 |
戻り値
型: HRESULT
このメソッドは次のいずれかの値を返すことができます。
| 戻り値 | 説明 |
|---|---|
| ハンドラーは削除可能なファイルのスキャンを続行する必要があります。 | |
| スキャンの実行中にユーザーがディスククリーンアップマネージャーのダイアログボックスで キャンセル ボタンをクリックすると、この値が返されます。ハンドラーはスキャンを停止してシャットダウンする必要があります。 |
解説(Remarks)
このメソッドは通常、ハンドラーが削除可能なファイルをスキャンしている間に、ハンドラーの GetSpaceUsed メソッドから呼び出されます。
削除可能なファイルの削除処理の進行状況をディスククリーンアップマネージャーに更新するために、ディスククリーンアップハンドラーから定期的に呼び出されます。
| dwlSpaceFreed | ULONGLONG | in | 削除処理のこの時点で解放されたディスク領域の量(バイト単位)。ディスククリーンアップマネージャーはこの値を使用して進行状況バーを更新します。 |
| dwlSpaceToFree | ULONGLONG | in | 削除処理のこの時点で解放する必要が残っているディスク領域の量(バイト単位)。 |
| dwFlags | DWORD | in | ディスククリーンアップマネージャーに送信できるフラグ。次の値を指定できます。 EVCCBF_LASTNOTIFICATIONハンドラーがこのメソッドを再度呼び出さない場合は、このフラグを設定します。通常は削除処理が完了に近づいたときに設定されます。 |
| pcwszStatus | LPWSTR | in | 予約済み。 |
戻り値
型: HRESULT
このメソッドは次のいずれかの値を返すことができます。
| 戻り値 | 説明 |
|---|---|
| ハンドラーは削除可能なファイルの削除を続行する必要があります。 | |
| スキャンの実行中にユーザーがディスククリーンアップマネージャーのダイアログボックスで キャンセル ボタンをクリックすると、この値が返されます。ハンドラーはファイルの削除を停止してシャットダウンする必要があります。 |
解説(Remarks)
このメソッドは通常、ハンドラーが削除可能なファイルを削除している間に、ハンドラーの Purge メソッドから呼び出されます。ハンドラーは、特に削除処理に時間がかかる場合には、ユーザーに進行状況を知らせ続けるために PurgeProgress を定期的に呼び出す必要があります。このメソッドを頻繁に呼び出すことで、ユーザーが削除処理をキャンセルした際にハンドラーが速やかにシャットダウンできるようにもなります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IEmptyVolumeCacheCallBack "{6E793361-73C6-11D0-8469-00AA00442901}"
#usecom global IEmptyVolumeCacheCallBack IID_IEmptyVolumeCacheCallBack "{}"
#comfunc global IEmptyVolumeCacheCallBack_ScanProgress 3 int64,int,wstr
#comfunc global IEmptyVolumeCacheCallBack_PurgeProgress 4 int64,int64,int,wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。