IActionProgress::UpdateText, méthode (shobjidl_core.h)
Appelé si le texte descriptif associé à l’action sera 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é. Consultez SPTEXT pour connaître les valeurs acceptables.
[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 permettre à une chaîne de texte d’être compactée pour s’adapter à l’espace disponible à l’écran.
Valeur retournée
Type : HRESULT
Retourne S_OK en cas de réussite ou une valeur d’erreur dans le cas contraire.
Notes
La classe implémentant cette méthode doit interpréter la valeur de sptext et fMayCompact dans le contexte de l’action en cours d’exécution et de l’interface utilisateur qui indique 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 désigne si la chaîne de texte peut être tronquée avec un ellipse (...) afin de conserver l’espace de l’écran.
Configuration requise
| 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 (include Shobjidl.h) |
| DLL | Shobjidl.idl |