Метод 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 в случае успешного выполнения или значение ошибки в противном случае.

Комментарии

Класс, реализующий этот метод, должен интерпретировать значение sptext и fMayCompact в контексте выполняемого действия и пользовательского интерфейса, который показывает ход выполнения пользователю. Значение sptext можно использовать для различения строк изменяемого текста. Часто значение fMayCompact указывает, можно ли усекать текстовую строку с многоточием (...) для экономии места на экране.

Требования

Требование	Значение
Минимальная версия клиента	Windows XP [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	shobjidl_core.h (включая Shobjidl.h)
DLL	Shobjidl.idl

См. также раздел

IActionProgress

SPTEXT