IOperationsProgressDialog::StartProgressDialog メソッド (shobjidl_core.h)

[アーティクル]
03/05/2024

指定した進行状況ダイアログを開始します。

構文

HRESULT StartProgressDialog(
  [in] HWND       hwndOwner,
  [in] OPPROGDLGF flags
);

パラメーター

[in] hwndOwner

型: HWND

親ウィンドウへのハンドル。

[in] flags

型: DWORD

操作をカスタマイズするフラグ。これらのフラグは Shlobj.h で宣言されていることに注意してください。次の値の組み合わせ。

PROGDLG_NORMAL (0x00000000)

既定の通常の進行状況ダイアログの動作。

PROGDLG_MODAL (0x00000001)

ダイアログは 、その hwndOwner にモーダルです。既定の設定はモードレスです。

PROGDLG_AUTOTIME (0x00000002)

"Line3" テキストを残り時間で更新します。 IOperationsProgressDialog::StartProgressDialog によって開始された進行状況ダイアログには残りの時間が自動的に表示されるため、このフラグを暗黙的に設定する必要はありません。

PROGDLG_NOTIME (0x00000004)

残りの時間は表示しないでください。このフラグはダイアログの目的に反するため、 IOperationsProgressDialog を使用して設定することはお勧めしません。

PROGDLG_NOMINIMIZE (0x00000008)

最小化ボタンは表示しないでください。

PROGDLG_NOPROGRESSBAR (0x00000010)

進行状況バーは表示しません。

PROGDLG_MARQUEEPROGRESS (0x00000020)

このフラグは、このメソッドでは無効です。進行状況バーをマーキーモードに設定するには、 IOperationsProgressDialog::SetMode のフラグを使用します。

PROGDLG_NOCANCEL (0x00000040)

操作を取り消すことができないため、キャンセルボタンを表示しないでください。この値は、絶対に必要な場合にのみ使用してください。

OPPROGDLG_DEFAULT (0x00000000)

Windows 7 以降。既定の通常の操作の進行状況ダイアログの動作を示します。

OPPROGDLG_ENABLEPAUSE (0x00000080)

一時停止ボタンを表示します。これは、操作を一時停止できる状況でのみ使用します。

OPPROGDLG_ALLOWUNDO (0x00000100)

操作は、ダイアログから元に戻すことができます。 [ 停止] ボタンが [元に戻す] になります。押すと、[元に戻す ] ボタンが [停止] に戻ります。

OPPROGDLG_DONTDISPLAYSOURCEPATH (0x00000200)

進行状況ダイアログにソースファイルのパスを表示しないでください。

OPPROGDLG_DONTDISPLAYDESTPATH (0x00000400)

進行状況ダイアログには、コピー先ファイルのパスを表示しないでください。

OPPROGDLG_NOMULTIDAYESTIMATES (0x00000800)

Windows 7 以降。完了までの推定時間が 1 日を超える場合は、時刻を表示しません。

OPPROGDLG_DONTDISPLAYLOCATIONS (0x00001000)

Windows 7 以降。進行状況ダイアログに場所の行を表示しないでください。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。そうでない場合は、HRESULT エラーコードを返します。

注釈

進行状況ダイアログは、ダイアログがレポートするファイル操作とは別のスレッドで作成する必要があります。ダイアログがファイル操作と同じスレッドで実行されている場合、進行状況メッセージは、リソースの許可としてのみ送信されます。ファイル操作と同じスレッドの進行状況メッセージがまったく送信されない場合があります。

IOperationsProgressDialog::StartProgressDialog が呼び出されると、CLSID_ProgressDialog オブジェクトのインスタンスに IProgressDialog、IActionProgressDialog、または IActionProgress がアクセスできなくなります。 QueryInterface を使用してこれらのインターフェイスにアクセスできますが、ほとんどのメソッドを呼び出すことはできません。 IOperationsProgressDialog は、Windows Vista 以降の操作エンジンの新しい進行状況ダイアログを表示するために使用されるインターフェイスです。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	shobjidl_core.h (Shobjidl.h を含む)