MLHtmlHelp-Funktion
[Diese Funktion ist über Windows XP und Windows Server 2003 verfügbar. Er kann in nachfolgenden Versionen von Windows geändert oder nicht verfügbar sein.]
Zeigt ein Hilfefenster an, das der aktuellen Einstellung der Benutzeroberflächensprache entspricht.
Syntax
HWND MLHtmlHelp(
_In_ HWND hwndCaller,
_In_ LPCTSTR pszFile,
_In_ UINT uCommand,
_In_ DWORD_PTR dwData,
_In_ DWORD dwCrossCodePage
);
Parameter
-
hwndCaller [ In]
-
Typ: HWND
Ein Handle für das übergeordnete Fenster, das diese Funktion aufruft.
-
pszFile [ In]
-
Typ: LPCTSTR
Ein Zeiger auf einen Puffer, der den vollqualifizierten Pfad einer kompilierten Hilfedatei (.chm) oder eine Themendatei in einer angegebenen Hilfedatei enthält.
-
uCommand [ In]
-
Typ: UINT
Der auszuführende Befehl. Diese Funktion unterstützt nur HH _ DISPLAY _ TOPIC und HH _ DISPLAY TEXT _ _ POPUPdirekt. Bei einem anderen Befehl wird der Aufruf ohne den dwCrossCodePage-Wert an HtmlHelpweitergeleitet.
-
dwData [ In]
-
Typ: DWORD _ PTR
Alle daten, die möglicherweise erforderlich sind, basierend auf dem Wert des uCommand-Parameters.
-
dwCrossCodePage [ In]
-
Typ: DWORD
Der DWORD-Wert, der die Codepage der aktuellen Ui-Spracheinstellung angibt, z. B. CP _ ACP.
Rückgabewert
Typ: HWND
Abhängig vom angegebenen uCommand und dem Ergebnis gibt MLHtmlHelp eine oder beide der folgenden Angaben zurück:
- Das Handle (hwnd) des Hilfefensters.
- NULL. In einigen Fällen weist NULL auf einen Fehler hin. in anderen Fällen gibt NULL an, dass das Hilfefenster noch nicht erstellt wurde.
Hinweise
Wenn ein Problem mit dem Pfad der Hilfedatei für die aktuelle Sprache auftritt, wird der Aufruf zur Standardbehandlung an HtmlHelp weitergeleitet.
Wenn das Hilfefenster geschlossen wird, wird der Fokus an den Besitzer zurückgegeben, es sei denn, der Besitzer ist der Desktop. Wenn hwndCaller der Desktop ist, bestimmt das Betriebssystem, wo der Fokus zurückgegeben wird.
Wenn MLHtmlHelp darüber hinaus Benachrichtigungsmeldungen aus dem Hilfefenster sendet, werden die Nachrichten an hwndCaller gesendet, solange Sie die Nachverfolgung von Benachrichtigungsmeldungen in der Definition des Hilfefensters aktiviert haben.
Beispiele
Im folgenden Beispiel wird der HH _ DISPLAY _ TOPIC-Befehl zum Öffnen der Hilfedatei help.chm und zum Anzeigen des Standardthemas im Hilfefenster mit dem Namen Mainwin verwendet. Im Allgemeinen ist das in diesem Befehl angegebene Hilfefenster ein standardmäßiger HTML-Hilfe-Viewer.
HWND hwnd = HtmlHelp(GetDesktopWindow(),
"c:\\Help.chm::/Intro.htm>Mainwin",
HH_DISPLAY_TOPIC,
NULL,
CP_ACP);
Hinweis
Legen Sie bei Verwendung dieser Funktion die Stapelgröße der ausführbaren Hostdatei auf mindestens 100.000 fest. Wenn die definierte Stapelgröße zu klein ist, wird der Thread, der zum Ausführen der HTML-Hilfe erstellt wurde, ebenfalls mit dieser Stapelgröße erstellt, und der Vorgang kann fehlschlagen. Optional können Sie /STACK über die Linkbefehlszeile und alle STACK-Einstellungen in der DEF-Datei der ausführbaren Datei entfernen (in diesem Fall beträgt die Standardstapelgröße 1 MB). Sie können die Stapelgröße auch mit dem Compilerbefehl /Fnumber festlegen (der Compiler übergibt dies als /STACK an den Linker).
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) |
Windows 2000 Professional, nur Windows [ XP-Desktop-Apps] |
| Unterstützte Mindestversion (Server) |
Windows Nur Server [ 2003-Desktop-Apps] |
| Header |
|
| DLL |
|
| Unicode- und ANSI-Name |
MLHtmlHelpW (Unicode) und MLHtmlHelpA (ANSI) |