Funzione MMCPropertyHelp (mmc.h)
La funzione MMCPropertyHelp viene introdotta in MMC 1.1.
La funzione MMCPropertyHelp visualizza l'argomento della Guida HTML specificato nel file della Guida HTML MMC unita per una pagina delle proprietà.
Sintassi
HRESULT MMCPropertyHelp(
LPOLESTR pszHelpTopic
);
Parametri
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 del file della Guida HTML dello snap-in (chm) unito nel file della Guida HTML MMC (solo nome file, non il percorso del file della Guida HTML originale) e topicfilename è 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.
Ad esempio, se lo snap-in aveva il file della Guida HTML mysnapin.chm unito al file della Guida HTML MMC e un file HTML di argomento con il percorso interno del file della Guida di htm/snphlp01.htm, la stringa avrà il formato seguente:
mysnapin.chm::htm/snphlp01.htm
Il supporto per gli ID numerici per gli argomenti non è disponibile in questa versione.
Valore restituito
Questa funzione di callback può restituire uno di questi valori.
Commenti
Chiamare MMCPropertyHelp nel gestore di notifica per la notifica di MMCN_CONTEXTHELP .
Uno snap-in può fornire la Guida del contesto in una pagina delle proprietà. 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 sommario 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 |