IActionProgress::UpdateText メソッド (shobjidl_core.h)

  • [アーティクル]

アクションに関連付けられている説明テキストが変更される場合に呼び出されます。

構文

HRESULT UpdateText(
  [in] SPTEXT  sptext,
  [in] LPCWSTR pszText,
  [in] BOOL    fMayCompact
);

パラメーター

[in] sptext

型: SPTEXT

表示されるテキストの種類を示す 値です。 許容される値については、「 SPTEXT 」を参照してください。

[in] pszText

種類: LPCWSTR

表示するワイド文字列へのポインター。

[in] fMayCompact

種類: BOOL

画面上の使用可能な領域に合わせてテキスト文字列を圧縮できるかどうかを示す 値です。

戻り値

型: HRESULT

成功した場合はS_OKを返し、それ以外の場合はエラー値を返します。

注釈

このメソッドを実装するクラスは、実行されるアクションのコンテキストおよびユーザーに進行状況を示す UI で 、sptext と fMayCompact の値を解釈する必要があります。 sptext の値を使用して、変更可能なテキストの行を区別できます。 fMayCompact の値は、多くの場合、画面領域を節約するために、省略記号 (...) でテキスト文字列を切り捨てることができるかどうかを示します。

要件

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

こちらもご覧ください

IActionProgress

SPTEXT