IActionProgress::UpdateText method (shobjidl_core.h)

  • Article

Called if descriptive text associated with the action will be changed.

Syntax

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

Parameters

[in] sptext

Type: SPTEXT

A value that specifies the type of text displayed. See SPTEXT for acceptable values.

[in] pszText

Type: LPCWSTR

A pointer to a wide character string to display.

[in] fMayCompact

Type: BOOL

A value that specifies whether to allow a text string to be compacted to fit the available space on screen.

Return value

Type: HRESULT

Return S_OK if successful, or an error value otherwise.

Remarks

The class implementing this method must interpret the value of sptext and fMayCompact in the context of the action being performed and the UI that shows the progress to the user. The value of sptext can be used to differentiate between lines of changeable text. Often, the value of fMayCompact refers to whether the text string can be truncated with an ellipsis (...) in order to conserve screen space.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shobjidl.h)
DLL Shobjidl.idl

See also

IActionProgress

SPTEXT