Metodo IDisplayHelp::ShowTopic (mmc.h)
Il metodo IDisplayHelp::ShowTopic visualizza l'argomento della Guida HTML specificato nel file della Guida HTML MMC unita.
Sintassi
HRESULT ShowTopic(
[in] LPOLESTR pszHelpTopic
);
Parametri
[in] pszHelpTopic
Puntatore a una stringa con terminazione NULL che specifica l'argomento da visualizzare nel file della Guida HTML MMC unito. La stringa deve avere il formato seguente:
helpfilename::topicfilename
dove helpfilename è il nome file del file della Guida HTML dello snap-in (chm) unito nel file di raccolta della Guida HTML MMC (questo è il nome file, non il percorso del file della Guida HTML originale) e il nomefile è il percorso interno del file dell'argomento all'interno del file chm dello snap-in. L'autore del file della Guida HTML dello snap-in determina se esiste una struttura di directory interna per i file HTML dell'argomento o se tutti i file HTML dell'argomento si trovano nella radice del file chm.
Uno snap-in indica a MMC il relativo file con estensione chm nell'implementazione del metodo ISnapinHelp2::GetHelpTopic .
Ad esempio, se lo snap-in aveva il file della Guida HTML mysnapin.chm unito al file di raccolta della Guida HTML MMC e un file HTML di argomento con il percorso interno del file htm/help01.htm, la stringa avrà il formato seguente:
mysnapin.chm::htm/help01.htm
Se invece il file dell'argomento help01.htm si trova nella radice del file della Guida mysnapin.chm, la stringa deve avere il formato seguente:
mysnapin.chm::/help01.htm
Il supporto per gli ID numerici per gli argomenti non è incluso nelle versioni 1.2 e versioni precedenti.
Valore restituito
Questo metodo può restituire uno di questi valori.
Commenti
MMC versione 1.0 e 1.1 richiede che pszHelpTopic venga allocato con la funzione API COM CoTaskMemAlloc e che MMC liberasse quindi la stringa. Questo ha violato le regole COM per l'allocazione di parametri in-parameter, che richiedono che siano allocati e liberati dal chiamante (lo snap-in). In MMC 1.2 e MMC 2.0 non è più necessario allocare pszHelpTopic con CoTaskMemAlloc. Il chiamante è libero di usare qualsiasi gestione della memoria desiderata. Se il chiamante sceglie di usare CoTaskMemAlloc, è anche responsabile della chiamata a CoTaskMemFree per liberare la stringa.
Uno snap-in può fornire informazioni sul contesto per l'elemento selezionato gestendo la notifica MMCN_CONTEXTHELP nel relativo metodo IComponent::Notify e chiamando IDisplayHelp::ShowTopic.
Per le pagine delle proprietà, lo snap-in deve chiamare MMCPropertyHelp anziché IDisplayHelp::ShowTopic. Poiché una finestra delle proprietà MMC è in genere in esecuzione in un thread separato, la pagina delle proprietà non può usare direttamente l'interfaccia IDisplayHelp . La pagina delle proprietà può invece chiamare MMCPropertyHelp dalla libreria MMC per ottenere lo stesso risultato. MMCPropertyHelp accetta lo stesso parametro stringa di argomento di IDisplayHelp::ShowTopic e gestisce il marshalling della richiesta al thread MMC principale.
Se lo snap-in gestisce la notifica di MMCN_CONTEXTHELP , MMC prevede che lo snap-in specifichi un argomento della Guida per l'elemento selezionato. Di conseguenza, nel gestore di notifica per la notifica di MMCN_CONTEXTHELP , lo snap-in ha due opzioni:
- Può chiamare IDisplayHelp::ShowTopic o MMCPropertyHelp per specificare l'argomento della Guida e quindi restituire S_OK per indicare l'esito positivo. Tenere presente che lo snap-in deve restituire solo S_OK se specifica un argomento della Guida. Se lo snap-in restituisce S_OK senza specificare un argomento della Guida, non verrà visualizzato alcun argomento della Guida.
- Può restituire S_FALSE alla notifica. MMC visualizza quindi il file di raccolta della Guida con l'argomento MMC predefinito selezionato.
Requisiti
| Client minimo supportato | Windows Vista |
| Server minimo supportato | Windows Server 2008 |
| Piattaforma di destinazione | Windows |
| Intestazione | mmc.h |
| DLL | Mmcndmgr.dll |