Méthode IExtendTaskPad ::GetDescriptiveText (mmc.h)

La méthode IExtendTaskPad ::GetDescriptiveText permet à MMC d’obtenir le texte descriptif du bloc-tâches à afficher dans les pavés de tâches qui utilisent des modèles de bloc-tâches MMC.

Syntaxe

HRESULT GetDescriptiveText(
  [in]  LPOLESTR pszGroup,
  [out] LPOLESTR *pszDescriptiveText
);

Paramètres

[in] pszGroup

Pointeur vers une chaîne terminée par null qui contient le nom de groupe qui identifie le bloc-tâches. Le nom du groupe est la chaîne qui suit le hachage (#) dans la chaîne transmise dans le paramètre ppViewType lorsque MMC appelle IComponent ::GetResultViewType pour afficher le bloc-tâches. Si aucun nom de groupe n’est spécifié, szGroup est une chaîne NULL .

[out] pszDescriptiveText

Pointeur vers l’adresse d’une chaîne terminée par null qui contient le texte descriptif du bloc-tâches spécifié par pszGroup. Ce texte s’affiche en haut du pavé de tâches sous le titre de l’ensemble du bloc-tâches. Ce texte peut être une expression qui sert de sous-titre ou d’instructions (telles que « Cliquer sur une action pour effectuer. »).

Si pszDescriptiveText pointe vers une chaîne NULL , aucun texte descriptif n’est affiché.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Remarques

Allouez la chaîne pszDescriptiveText avec la fonction d’API COM CoTaskMemAlloc (ou l’équivalent) et MMC la libère.

Configuration requise

Voir aussi

IExtendTaskPad