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

[アーティクル]
08/23/2023

指定したレジストリキーに格納されている情報に基づいて、ディスククリーンアップハンドラーを初期化します。

構文

HRESULT Initialize(
  [in]      HKEY    hkRegKey,
  [in]      LPCWSTR pcwszVolume,
  [out]     LPWSTR  *ppwszDisplayName,
  [out]     LPWSTR  *ppwszDescription,
  [in, out] DWORD   *pdwFlags
);

パラメーター

[in] hkRegKey

種類: HKEY

ハンドラーオブジェクトに関する情報を保持するレジストリキーへのハンドル。

[in] pcwszVolume

種類: LPCWSTR

ボリュームルートを持つ null で終わる Unicode 文字列へのポインター ("C:" など)。

[out] ppwszDisplayName

種類: LPWSTR*

ディスククリーンアップマネージャーのハンドラーの一覧に表示される名前を持つ null で終わる Unicode 文字列へのポインター。値が割り当てられていない場合は、レジストリ値が使用されます。

[out] ppwszDescription

種類: LPWSTR*

このオブジェクトがディスククリーンアップマネージャーの使用可能なディスククリーンアップハンドラーの一覧から選択されたときに表示される null で終わる Unicode 文字列へのポインター。値が割り当てられていない場合は、レジストリ値が使用されます。

[in, out] pdwFlags

種類: DWORD*

ハンドラーに情報を渡し、ディスククリーンアップマネージャーに戻すために使用されるフラグ。

これらのフラグは、オブジェクトに渡すことができます。

EVCF_OUTOFDISKSPACE

このフラグが設定されている場合、ユーザーはドライブのディスク領域を使い切ります。このフラグを受信すると、パフォーマンスが低下した場合でも、ハンドラーはディスク領域の解放に対して積極的である必要があります。ただし、ハンドラーは、アプリケーションが失敗したり、ユーザーがデータを失ったりする原因となるファイルを削除しないでください。

EVCF_SETTINGSMODE

ディスククリーンアップマネージャーがスケジュールに従って実行されている場合は、このフラグが設定されます。 ppwszDisplayName パラメーターと ppwszDescription パラメーターに値を割り当てる必要があります。このフラグが設定されている場合、ディスククリーンアップマネージャーは IEmptyVolumeCache::GetSpaceUsed、 IEmptyVolumeCache::P urge、または IEmptyVolumeCache::ShowProperties を呼び出しません。 IEmptyVolumeCache::P urge は呼び出されないため、クリーンアップは IEmptyVolumeCache::Initialize によって処理する必要があります。ハンドラーは、pcwszVolume パラメーターを無視し、不要なファイルがオンになっているドライブに関係なくクリーンする必要があります。ユーザーからのフィードバックを受ける機会がないため、クリーンしても非常に安全なファイルにのみ触れる必要があります。

これらのフラグは、ハンドラーによってディスククリーンアップマネージャーに戻すことができます。

EVCF_DONTSHOWIFZERO

削除するファイルがない場合は、このフラグを設定します。 IEmptyVolumeCache::GetSpaceUsed が呼び出された場合は、pdwSpaceUsed パラメーターを 0 に設定します。ディスククリーンアップマネージャーは、その一覧からハンドラーを省略します。

EVCF_ENABLEBYDEFAULT

このフラグを設定すると、クリーンアップマネージャーの一覧でハンドラーが既定でチェックされます。ユーザーがハンドラーの [チェック] ボックスをオフにしない限り、ディスククリーンアップユーティリティが実行されるたびに実行されます。チェックボックスがクリアされると、ユーザーが再度選択するまでハンドラーは実行されません。

EVCF_ENABLEBYDEFAULT_AUTO

スケジュールされたクリーンアップ中にハンドラーが自動的に実行されるようにするには、このフラグを設定します。このフラグは、ファイルの削除リスクが低い場合にのみ設定する必要があります。 EVCF_ENABLEBYDEFAULTと同様に、ユーザーは、ディスククリーンアップマネージャーの一覧の [チェック] ボックスをオフにすることで、ハンドラーを実行しないことを選択できます。

EVCF_HASSETTINGS

ハンドラーが UI を表示できることを示すには、このフラグを設定します。単純な UI の例として、削除可能なファイルを表示し、ユーザーが削除するファイルを選択できるリストボックスがあります。ディスククリーンアップマネージャーは、クリーンアップハンドラーの説明の下にボタンを表示します。ユーザーがこのボタンをクリックして UI を要求します。既定のボタンテキストは "Settings" ですが、ハンドラーはレジストリキーに AdvancedButtonText 値を設定することで別のテキストを指定できます。

EVCF_REMOVEFROMLIST

ディスククリーンアップマネージャーの一覧からハンドラーを削除するには、このフラグを設定します。すべてのレジストリ情報が削除され、キーとその値が復元されるまでハンドラーを再度実行することはできません。このフラグは、主に 1 回限りのクリーンアップ操作に使用されます。

戻り値

種類: HRESULT

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

リターンコード	説明
S_OK	成功しました。
S_FALSE	削除するファイルはありません。
E_ABORT	クリーンアップ操作が途中で終了しました。
E_FAIL	クリーンアップ操作が失敗しました。

解説

この方法は、Windows 98 ディスククリーンアップマネージャーによって使用されます。 Windows 2000 では、IEmptyVolumeCache2 によってエクスポートされた InitializeEx メソッドが使用されます。

CoTaskMemAlloc を使用して、ppwszDisplayName と ppwszDescription を介して返される文字列のメモリを割り当てます。ディスククリーンアップマネージャーは、不要になったときにメモリを解放します。

要件


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