HtmlHelpA-Funktion (htmlhelp.h)
Zeigt ein Hilfefenster an.
Mithilfe der API-Befehle können Sie angeben, welches Thema im Hilfefenster angezeigt werden soll, ob das Hilfefenster ein Hilfe-Viewer mit drei Bereichen oder ein Popupfenster ist und ob auf die HTML-Themendatei über eine Kontext-ID, eine HTML-Hilfe-URL oder eine Stichwortlinksuche (KLink) zugegriffen werden soll.
Syntax
HWND HtmlHelpA(
[in, optional] HWND hwndCaller,
[in] LPCSTR pszFile,
[in] UINT uCommand,
[in] DWORD_PTR dwData
);
Parameter
[in, optional] hwndCaller
Gibt das Handle (hwnd) des Fensters an, das HtmlHelp aufruft. Das Hilfefenster gehört diesem Fenster.
Wenn das Hilfefenster geschlossen wird, gibt HtmlHelp den Fokus auf 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 HtmlHelp Benachrichtigungen aus dem Hilfefenster sendet, werden diese außerdem an hwndCaller gesendet, solange Sie die Nachverfolgung von Benachrichtigungen in der Definition des Hilfefensters aktiviert haben.
[in] pszFile
Gibt je nach uCommand-Wert den Dateipfad zu einer kompilierten Hilfedatei (CHM) oder einer Themendatei innerhalb einer angegebenen Hilfedatei an.
Ein Fenstertypname kann auch angegeben werden, dem ein Zeichen größer als (>) vorangestellt ist.
Wenn für den angegebenen Befehl keine Datei erforderlich ist, ist dieser Wert möglicherweise NULL.
[in] uCommand
Gibt den auszuführenden Befehl an.
[in] dwData
Gibt alle erforderlichen Daten basierend auf dem Wert des uCommand-Parameters an.
Rückgabewert
Abhängig vom angegebenen uCommand und dem Ergebnis gibt HtmlHelp einen oder beide der folgenden Rückgaben zurück:
- Das Handle (hwnd) des Hilfefensters.
NULL. In einigen Fällen gibt NULL einen Fehler an. in anderen Fällen gibt NULL an, dass das Hilfefenster noch nicht erstellt wurde.
Hinweise
Die Syntax gilt für ANSI-Zeichensätze. Bei Verwendung eines Unicode-Zeichensatzes sollte der Typ des pszFile-Parameters "LPCTSTR" sein.
Legen Sie bei Verwendung der HTML-Hilfe-API 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 es kann zu Fehlern kommen. Optional können Sie /STACK aus der Linkbefehlszeile und 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 als /STACK an den Linker).
Beispiele
Im folgenden Beispiel wird der Befehl HH_DISPLAY_TOPIC aufgerufen, um die Hilfedatei mit dem Namen Help.chm zu öffnen und ihr Standardthema im Hilfefenster mit dem Namen Mainwin anzuzeigen. 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) ;
Hinweis
Der htmlhelp.h-Header definiert HtmlHelp als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.
Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform | Windows |
| Kopfzeile | htmlhelp.h |
| Bibliothek | Htmlhelp.lib |
| DLL | hhctrl.ocx |