ISnapinHelp::GetHelpTopic-Methode (mmc.h)
Ermöglicht einem Snap-In das Hinzufügen der kompilierten HTML-Hilfedatei zur MMC-Hilfesammlungsdatei.
Syntax
HRESULT GetHelpTopic(
[out] LPOLESTR *lpCompiledHelpFile
);
Parameter
[out] lpCompiledHelpFile
Ein Zeiger auf die Adresse der mit Null beendeten Unicode-Zeichenfolge, die den Pfad der kompilierten Hilfedatei (CHM) für das Snap-In enthält. Wenn Sie den Pfad angeben, platzieren Sie die Datei an einer beliebigen Stelle, und geben Sie den vollständigen Pfadnamen an.
Rückgabewert
Diese Methode kann einen dieser Werte zurückgeben.
Hinweise
MMC ruft die Implementierung dieser Methode des Snap-Ins auf, um den Speicherort der Hilfedatei des Snap-Ins abzurufen. MMC führt die HTML-Hilfedateien aller Snap-Ins mit der HTML-Hilfesammlungsdatei der MMC-Konsole zusammen.
Die Themenhierarchie aus der Hilfedatei des Snap-Ins wird im Inhaltsverzeichnis angezeigt, wenn die Auflistung angezeigt wird.
Durch das Zusammenführen der HTML-Hilfedateien erstellt MMC ein einzelnes, integriertes HTML-Hilfeverzeichnis mit Inhalt, Index und Suchfunktion. Wenn ein Benutzer im Standard-Menü Hilfe in der Microsoft-Verwaltungskonsole auf Hilfe klickt, öffnet MMC die zusammengeführte Hilfedatei, die HTML-Hilfedateien für alle Snap-Ins in der aktuellen Konsolendatei enthält.
Ordnen Sie die lpCompiledHelpFile-Zeichenfolge mit der COM-API-Funktion CoTaskMemAlloc (oder der entsprechenden) zu, und MMC gibt sie frei.
Beispiele
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;
}
Anforderungen
| Unterstützte Mindestversion (Client) | Windows Vista |
| Unterstützte Mindestversion (Server) | Windows Server 2008 |
| Zielplattform | Windows |
| Kopfzeile | mmc.h |