Metodo ISnapinHelp::GetHelpTopic (mmc.h)

Articolo
08/24/2023

Consente a uno snap-in di aggiungere il file della Guida HTML compilato al file di raccolta della Guida MMC.

Sintassi

HRESULT GetHelpTopic(
  [out] LPOLESTR *lpCompiledHelpFile
);

Parametri

[out] lpCompiledHelpFile

Puntatore all'indirizzo della stringa Unicode con terminazione null contenente il percorso del file della Guida compilata (con estensione chm) per lo snap-in. Quando si specifica il percorso, posizionare il file ovunque e specificare il nome completo del percorso.

Valore restituito

Questo metodo può restituire uno di questi valori.

Commenti

MMC chiama l'implementazione dello snap-in di questo metodo per ottenere il percorso del file della Guida dello snap-in. MMC unisce i file della Guida HTML di tutti gli snap-in con il file di raccolta della guida HTML della console MMC.

La gerarchia degli argomenti del file Della Guida dello snap-in verrà visualizzata nel sommario quando viene visualizzata la raccolta.

Tramite l'unione dei file della Guida HTML, MMC crea un singolo e integrato sommario della Guida HTML, indice e funzionalità di ricerca. Quando un utente fa clic sulla Guida in Microsoft Management Console nel menu della Guida principale, MMC apre il file della Guida unito che include i file della Guida HTML per tutti gli snap-in nel file della console corrente.

Allocare la stringa lpCompiledHelpFile con la funzione API COM CoTaskMemAlloc (o equivalente) e MMC lo rilascia.

Esempio

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;
}