IEmptyVolumeCache::GetSpaceUsed メソッド (emptyvc.h)

  • [アーティクル]

ディスク クリーンアップ ハンドラーが解放できるディスク領域の量を要求します。

構文

HRESULT GetSpaceUsed(
  [out] DWORDLONG                 *pdwlSpaceUsed,
  [in]  IEmptyVolumeCacheCallBack *picb
);

パラメーター

[out] pdwlSpaceUsed

型: DWORDLONG*

ハンドラーが解放できるディスク領域の量 (バイト単位)。 この値は、ハンドラーの [チェック] ボックスの右側にあるディスク クリーンアップ マネージャーの一覧に表示されます。 解放できるディスク領域の量がわからないことを示すには、このパラメーターを -1 に設定し、"???MB" が表示されます。 Initialize が呼び出されたときにEVCF_DONTSHOWIFZERO フラグを設定した場合、pdwSpaceUsed を 0 に設定すると、ディスク クリーンアップ マネージャーに一覧からハンドラーを省略するように通知されます。

[in] picb

種類: IEmptyVolumeCacheCallback*

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

戻り値

型: HRESULT

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

リターン コード 説明
S_OK
 成功しました。
S_FALSE
 ハンドラーが解放できるディスク領域の量を計算しようとしたときにエラーが発生しました。
E_ABORT
 スキャン操作が途中で終了しました。 この値は通常、 ScanProgress の呼び出しがE_ABORTを返すときに返されます。 この戻り値は、ユーザーがディスク クリーンアップ マネージャーの [キャンセル] ボタンをクリックして操作を 取り消 したことを示します。

注釈

このメソッドがディスク クリーンアップ マネージャーによって呼び出されると、ハンドラーはファイルのスキャンを開始して、削除できるファイルと解放されるディスク領域を決定する必要があります。 ハンドラーは IEmptyVolumeCache::ScanProgress を定期的に呼び出して、スキャンの進行状況をユーザーに知らせる必要があります(特に時間がかかる場合)。 このメソッドを頻繁に呼び出すと、ハンドラーはユーザーが操作を取り消したかどうかを判断することもできます。 ScanProgress がE_ABORTを返した場合、ユーザーはスキャンを取り消しました。 ハンドラーはすぐにスキャンを停止し、E_ABORTを返す必要があります。

pdwSpaceUsed パラメーターは、最後の手段として -1 にのみ設定する必要があります。 解放される領域がわからない場合、ハンドラーの値はユーザーに限定されます。

要件

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