Méthode IActionProgress ::UpdateText (shobjidl_core.h)

  • Article

Appelé si le texte descriptif associé à l’action est modifié.

Syntaxe

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

Paramètres

[in] sptext

Type : SPTEXT

Valeur qui spécifie le type de texte affiché. Pour connaître les valeurs acceptables, consultez SPTEXT .

[in] pszText

Type : LPCWSTR

Pointeur vers une chaîne de caractères large à afficher.

[in] fMayCompact

Type : BOOL

Valeur qui spécifie s’il faut autoriser le compactage d’une chaîne de texte pour s’adapter à l’espace disponible à l’écran.

Valeur retournée

Type : HRESULT

Retournez S_OK en cas de réussite, ou une valeur d’erreur dans le cas contraire.

Remarques

La classe qui implémente cette méthode doit interpréter la valeur de sptext et de fMayCompact dans le contexte de l’action en cours d’exécution et de l’interface utilisateur qui montre la progression à l’utilisateur. La valeur de sptext peut être utilisée pour différencier les lignes de texte modifiable. Souvent, la valeur de fMayCompact indique si la chaîne de texte peut être tronquée avec des points de suspension (...) afin de conserver l’espace d’écran.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête shobjidl_core.h (incluez Shobjidl.h)
DLL Shobjidl.idl

Voir aussi

IActionProgress

SPTEXT