Freigeben über


IActionProgress::UpdateText-Methode (shobjidl_core.h)

Wird aufgerufen, wenn der der Aktion zugeordneter beschreibender Text geändert wird.

Syntax

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

Parameter

[in] sptext

Typ: SPTEXT

Ein Wert, der den Typ des angezeigten Texts angibt. Akzeptable Werte finden Sie unter SPTEXT .

[in] pszText

Typ: LPCWSTR

Ein Zeiger auf eine anzuzeigende breite Zeichenfolge.

[in] fMayCompact

Typ: BOOL

Ein Wert, der angibt, ob eine Textzeichenfolge so komprimiert werden soll, dass sie dem verfügbaren Platz auf dem Bildschirm entspricht.

Rückgabewert

Typ: HRESULT

Zurückgeben S_OK bei erfolgreicher Ausführung oder andernfalls einen Fehlerwert.

Hinweise

Die Klasse, die diese Methode implementiert, muss den Wert von sptext und fMayCompact im Kontext der ausgeführten Aktion und der Benutzeroberfläche interpretieren, die dem Benutzer den Fortschritt anzeigt. Der Wert von sptext kann verwendet werden, um zwischen Zeilen mit veränderlichem Text zu unterscheiden. Häufig bezieht sich der Wert von fMayCompact darauf, ob die Textzeichenfolge mit einem Auslassungszeichen (...) abgeschnitten werden kann, um Platz auf dem Bildschirm zu sparen.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shobjidl_core.h (einschließlich Shobjidl.h)
DLL Shobjidl.idl

Weitere Informationen

IActionProgress

SPTEXT