Méthode ISnapinHelp::GetHelpTopic (mmc.h)

Article
08/24/2023

Permet à un composant logiciel enfichable d’ajouter son fichier d’aide HTML compilé au fichier de collection d’aide MMC.

Syntaxe

HRESULT GetHelpTopic(
  [out] LPOLESTR *lpCompiledHelpFile
);

Paramètres

[out] lpCompiledHelpFile

Pointeur vers l’adresse de la chaîne Unicode terminée par null qui contient le chemin d’accès du fichier d’aide compilé (.chm) pour le composant logiciel enfichable. Lorsque vous spécifiez le chemin d’accès, placez le fichier n’importe où et spécifiez le nom complet du chemin d’accès.

Valeur retournée

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

Notes

MMC appelle l’implémentation du composant logiciel enfichable de cette méthode pour obtenir l’emplacement du fichier d’aide du composant logiciel enfichable. MMC fusionne les fichiers d’aide HTML de tous les composants logiciels enfichables avec le fichier de collection d’aide HTML de la console MMC.

La hiérarchie de rubriques du fichier d’aide du composant logiciel enfichable s’affiche dans la table des matières lorsque la collection est affichée.

En fusionnant les fichiers d’aide HTML, MMC crée une table des matières, un index et une fonctionnalité de recherche HTML unique et intégrée. Lorsqu’un utilisateur clique sur Aide sur la console de gestion Microsoft dans le menu Aide main, MMC ouvre le fichier d’aide fusionné qui inclut les fichiers d’aide HTML pour tous les composants logiciels enfichables dans le fichier console actuel.

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

Exemples

STDMETHODIMP CComponentData::GetHelpTopic( LPOLESTR *lpCompiledFile )
{
    LPOLESTR lpHelpFile;
 
    if ( !lpCompiledFile )
        return E_POINTER; // invalid argument
 
    lpHelpFile = (LPOLESTR) CoTaskMemAlloc( MAX_PATH * sizeof(WCHAR) );
 
    if ( !lpHelpFile )
    {
        return E_OUTOFMEMORY;
    }
 
    ExpandEnvironmentStringsW( L"%SystemRoot%\\Help\\myhelpfile.chm", lpHelpFile, MAX_PATH );
 
    *lpCompiledHelpFile = lpHelpFile;
 
    return S_OK;
}