MLHtmlHelp-Funktion

[Diese Funktion ist über Windows XP und Windows Server 2003 verfügbar. In nachfolgenden Windows-Versionen ist sie möglicherweise geändert oder nicht verfügbar.]

Zeigt ein Hilfefenster an, das der aktuellen Spracheinstellung der Benutzeroberfläche 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 einer Themendatei in einer angegebenen Hilfedatei enthält.

uCommand [in]

Typ: UINT

Der auszuführende Befehl. Diese Funktion unterstützt direkt nur HH_DISPLAY_TOPIC und HH_DISPLAY_TEXT_POPUP. Bei jedem anderen Befehl wird der Aufruf ohne den Wert dwCrossCodePage an HtmlHelp weitergeleitet.

dwData [in]

Typ: DWORD_PTR

Alle Daten, die möglicherweise erforderlich sind, basierend auf dem Wert des uCommand-Parameters .

dwCrossCodePage [in]

Art: DWORD

Der DWORD-Wert , der die Codepage der aktuellen Benutzeroberflächenspracheinstellung angibt, z. B. CP_ACP.

Rückgabewert

Typ: HWND

Abhängig vom angegebenen uCommand und dem Ergebnis gibt MLHtmlHelp einen oder beide der folgenden Zurückgegeben:

  • 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.

Bemerkungen

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, kehrt der Fokus an den Besitzer zurück, es sei denn, der Besitzer ist der Desktop. Wenn hwndCaller der Desktop ist, bestimmt das Betriebssystem, wo der Fokus zurückgegeben wird.

Wenn MLHtmlHelp außerdem Benachrichtigungsmeldungen aus dem Hilfefenster sendet, werden die Nachrichten an hwndCaller gesendet, solange Sie die Benachrichtigungsmeldungsnachverfolgung in der Definition des Hilfefensters aktiviert haben.

Beispiele

Im folgenden Beispiel wird der Befehl HH_DISPLAY_TOPIC aufgerufen, um die Hilfedatei Help.chm zu öffnen und das Standardthema im Hilfefenster mit dem Namen Mainwinanzuzeigen. Im Allgemeinen handelt es sich bei dem in diesem Befehl angegebenen Hilfefenster um einen standardmäßigen 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 Hostingdatei auf mindestens 100.000 fest. Wenn die definierte Stapelgröße zu klein ist, wird der zum Ausführen der HTML-Hilfe erstellte Thread auch mit dieser Stapelgröße erstellt, und der Vorgang kann fehlschlagen. Optional können Sie /STACK aus der Link-Befehlszeile entfernen und auch jede STACK-Einstellung in der DEF-Datei der ausführbaren Datei entfernen (in diesem Fall ist die Standardstapelgröße 1 MB). Sie können die Stapelgröße auch mit dem Compilerbefehl /Fnumber festlegen (der Compiler übergibt diese an den Linker als /STACK).

 

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client)
Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)
Windows Server 2003 [nur Desktop-Apps]
Header
Keine
DLL
Shlwapi.dll (Version 5.0 oder höher)
Unicode- und ANSI-Name
MLHtmlHelpW (Unicode) und MLHtmlHelpA (ANSI)