MMCPropertyHelp, fonction (mmc.h)
La fonction MMCPropertyHelp est introduite dans MMC 1.1.
La fonction MMCPropertyHelp affiche la rubrique d’aide HTML spécifiée dans le fichier d’aide HTML MMC fusionné pour une page de propriétés.
Syntaxe
HRESULT MMCPropertyHelp(
LPOLESTR pszHelpTopic
);
Paramètres
pszHelpTopic
Pointeur vers une chaîne terminée par null spécifiant la rubrique à afficher dans le fichier d’aide HTML MMC fusionné. La chaîne doit avoir le format suivant :
helpfilename::topicfilename
où helpfilename est le nom de fichier du fichier d’aide HTML du composant logiciel enfichable (.chm) que MMC a fusionné dans le fichier d’aide HTML MMC (nom de fichier uniquement, pas le chemin d’accès au fichier d’aide HTML d’origine) et topicfilename est le chemin d’accès interne au fichier de rubrique dans le fichier .chm du composant logiciel enfichable. L’auteur du fichier d’aide HTML du composant logiciel enfichable détermine s’il existe une structure de répertoires interne pour les fichiers HTML de la rubrique ou si tous les fichiers HTML de rubrique se trouvent à la racine du fichier .chm.
Par exemple, si le composant logiciel enfichable avait le fichier d’aide HTML mysnapin.chm fusionné dans le fichier d’aide HTML MMC et un fichier HTML de rubrique dont le chemin d’accès interne au fichier d’aide était htm/snphlp01.htm, la chaîne aurait la forme suivante :
mysnapin.chm::htm/snphlp01.htm
La prise en charge des ID numériques pour les rubriques n’est pas disponible dans cette version.
Valeur retournée
Cette fonction de rappel peut retourner l’une de ces valeurs.
Notes
Appelez MMCPropertyHelp dans le gestionnaire de notifications pour la notification MMCN_CONTEXTHELP .
Un composant logiciel enfichable peut fournir une aide contextuelle sur une page de propriétés. Étant donné qu’une feuille de propriétés MMC s’exécute généralement sur un thread distinct, la page de propriétés ne peut pas utiliser directement l’interface IDisplayHelp . Au lieu de cela, la page de propriétés peut appeler MMCPropertyHelp à partir de la bibliothèque MMC pour obtenir le même résultat. MMCPropertyHelp prend le même paramètre de chaîne de rubrique que IDisplayHelp::ShowTopic et gère le marshaling de la requête vers le thread MMC main.
Si le composant logiciel enfichable gère la notification MMCN_CONTEXTHELP , MMC s’attend à ce que le composant logiciel enfichable spécifie une rubrique d’aide pour l’élément sélectionné. Par conséquent, dans le gestionnaire de notification pour la notification MMCN_CONTEXTHELP , le composant logiciel enfichable a deux options :
- Il peut appeler IDisplayHelp::ShowTopic ou MMCPropertyHelp pour spécifier la rubrique d’aide, puis retourner S_OK pour indiquer la réussite. N’oubliez pas que le composant logiciel enfichable ne doit retourner S_OK que s’il spécifie une rubrique d’aide. Si le composant logiciel enfichable retourne S_OK sans spécifier de rubrique d’aide, aucune rubrique d’aide ne s’affiche.
- Il peut retourner S_FALSE à la notification. MMC affiche ensuite la table des matières avec la rubrique MMC par défaut sélectionnée.
Configuration requise
| Client minimal pris en charge | Windows Vista |
| Serveur minimal pris en charge | Windows Server 2008 |
| Plateforme cible | Windows |
| En-tête | mmc.h |