IProgressDialog::SetCancelMsg メソッド (shlobj_core.h)

  • [アーティクル]

ユーザーが操作をキャンセルした場合に表示されるメッセージを設定します。

構文

HRESULT SetCancelMsg(
  [in] PCWSTR  pwzCancelMsg,
       LPCVOID pvResevered
);

パラメーター

[in] pwzCancelMsg

種類: PCWSTR

表示するメッセージを含む null で終わる Unicode 文字列へのポインター。

pvResevered

種類: LPCVOID

予約済み。 NULL に設定します。

戻り値

型: HRESULT

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

注釈

ユーザーが [キャンセル] をクリックしても、アプリケーションは IProgressDialog::StopProgressDialog をすぐに呼び出してダイアログ ボックスを閉じることはできません。 アプリケーションは、次回 IProgressDialog::HasUserCancelled を呼び出して、ユーザーが操作を取り消したことを検出するまで待機する必要があります。 この遅延は大きくなる可能性があるため、進行状況ダイアログ ボックスでは、テキスト行 1 と 2 をクリアし、3 行目にキャンセル メッセージを表示することで、ユーザーに即座にフィードバックを提供します。 このメッセージは、遅延が正常であり、進行状況ダイアログ ボックスが間もなく閉じられることをユーザーに知らせるために使用されます。 これは通常、"しばらくお待ちください..." のような設定です。

要件

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

こちらもご覧ください

IProgressDialog