IActionProgress インターフェイス (shobjidl_core.h)
進行状況に基づく操作を継承できる抽象基本クラスを表します。
継承
IActionProgress インターフェイスは、IUnknown インターフェイスから継承されます。 IActionProgress には、次の種類のメンバーもあります。
メソッド
IActionProgress インターフェイスには、これらのメソッドがあります。
|
IActionProgress::Begin 進行状況をユーザーに表示する必要があるアクションが開始されたときに呼び出されます。 |
|
IActionProgress::End この進行状況の実装に関連付けられているアクションが終了したことを示します。 |
|
IActionProgress::QueryCancel アクションが取り消されるかどうかに関する情報を提供します。 |
|
IActionProgress::ResetCancel 取り消しが完了した後、進行状況ダイアログをリセットします。 |
|
IActionProgress::UpdateProgress アクションの進行状況を UI に更新します。 |
|
IActionProgress::UpdateText アクションに関連付けられている説明テキストが変更された場合に呼び出されます。 |
注釈
このクラスは、インスタンス化できない抽象クラスです。 これは、派生クラスが進行状況コールバックを実装するために使用できるフレームワークを提供します。 このコールバックは、アプリケーションがアクションの進行状況を UI に報告するために使用できます。 ここで「アクション」とは、ファイルのダウンロードやコピーなど、かなりの時間がかかる可能性があり、その間に目に見える進行状況を示す操作を指します。
通常、アプリケーションはこのインターフェイスを実装しません。 アクション中にユーザーが操作する機能の多くは、 IActionProgress を実装し、ダイアログ ボックスに進行状況を表示する CProgressDialog クラス (CLSID_ProgressDialog) によって提供されます。 ダイアログ ボックス以外のメカニズムを必要とするソリューションが必要な場合は、 IActionProgress を 使用して基本的な進行状況インジケーター機能を提供できます。
実装されると、クラスはアクションの開始時に IActionProgress::Begin を呼び出す必要があります。 IActionProgress::UpdateProgress を定期的に呼び出して UI を進行状況情報で更新し、詳細なテキスト情報を IActionProgress::UpdateText を呼び出して UI に伝達する必要があります。 取り消し要求を処理するには、IActionProgress::QueryCancel と IActionProgress::ResetCancel を呼び出す必要があります。 操作が終了したら、 IActionProgress::End を呼び出す必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | shobjidl_core.h (Shobjidl.h を含む) |