MMCPropertyHelp-Funktion (mmc.h)
Die MMCPropertyHelp-Funktion wird in MMC 1.1 eingeführt.
Die MMCPropertyHelp-Funktion zeigt das angegebene HTML-Hilfethema in der zusammengeführten MMC-HTML-Hilfedatei für eine Eigenschaftenseite an.
Syntax
HRESULT MMCPropertyHelp(
LPOLESTR pszHelpTopic
);
Parameter
pszHelpTopic
Ein Zeiger auf eine NULL-endende Zeichenfolge, die das Thema angibt, das in der zusammengeführten MMC-HTML-Hilfedatei angezeigt werden soll. Die Zeichenfolge muss das folgende Format aufweisen:
helpfilename::topicfilename
Dabei ist helpfilename der Dateiname der HTML-Hilfedatei (CHM) des Snap-Ins, die MMC in die MMC-HTML-Hilfedatei zusammengeführt hat (nur Dateiname, nicht der Pfad zur ursprünglichen HTML-Hilfedatei), und topicfilename ist der interne Pfad zur Themendatei innerhalb der CHM-Datei des Snap-Ins. Der Autor der HTML-Hilfedatei des Snap-Ins bestimmt, ob eine interne Verzeichnisstruktur für die HTML-Themendateien vorhanden ist oder ob sich alle HTML-Themendateien im Stammverzeichnis der CHM-Datei befinden.
Wenn das Snap-In beispielsweise die HTML-Hilfedatei mysnapin.chm in die MMC-HTML-Hilfedatei und eine HTML-Themendatei mit dem internen Hilfedateipfad htm/snphlp01.htm zusammengeführt würde, hätte die Zeichenfolge die folgende Form:
mysnapin.chm::htm/snphlp01.htm
Die Unterstützung für numerische IDs für Themen ist in dieser Version nicht verfügbar.
Rückgabewert
Diese Rückruffunktion kann einen dieser Werte zurückgeben.
Hinweise
Rufen Sie MMCPropertyHelp im Benachrichtigungshandler für die MMCN_CONTEXTHELP Benachrichtigung auf.
Ein Snap-In kann Kontexthilfe auf einer Eigenschaftenseite bereitstellen. Da ein MMC-Eigenschaftenblatt in der Regel in einem separaten Thread ausgeführt wird, kann die Eigenschaftenseite die IDisplayHelp-Schnittstelle nicht direkt verwenden. Stattdessen kann die Eigenschaftenseite MMCPropertyHelp aus der MMC-Bibliothek aufrufen, um das gleiche Ergebnis zu erzielen. MMCPropertyHelp verwendet den gleichen Themenzeichenfolgenparameter wie IDisplayHelp::ShowTopic und verarbeitet das Marshallen der Anforderung an den Standard MMC-Thread.
Wenn das Snap-In die MMCN_CONTEXTHELP Benachrichtigung verarbeitet, erwartet MMC, dass das Snap-In ein Hilfethema für das ausgewählte Element angibt. Folglich verfügt das Snap-In im Benachrichtigungshandler für die MMCN_CONTEXTHELP-Benachrichtigung über zwei Optionen:
- Sie kann IDisplayHelp::ShowTopic oder MMCPropertyHelp aufrufen, um das Hilfethema anzugeben und dann S_OK zurückzugeben, um den Erfolg anzuzeigen. Beachten Sie, dass das Snap-In nur dann S_OK zurückgeben sollte, wenn es ein Hilfethema angibt. Wenn das Snap-In S_OK ohne Angabe eines Hilfethemas zurückgibt, wird kein Hilfethema angezeigt.
- Es kann S_FALSE an die Benachrichtigung zurückgeben. MMC zeigt dann das Inhaltsverzeichnis mit ausgewähltem MMC-Standardthema an.
Anforderungen
| Unterstützte Mindestversion (Client) | Windows Vista |
| Unterstützte Mindestversion (Server) | Windows Server 2008 |
| Zielplattform | Windows |
| Kopfzeile | mmc.h |