HtmlHelpA-Funktion (htmlhelp.h)
Zeigt ein Hilfefenster an.
Mithilfe der API-Befehle können Sie angeben, welches Thema im Hilfefenster angezeigt werden soll, unabhängig davon, ob es sich bei dem Hilfefenster um einen Dreibereich-Hilfe-Viewer oder ein Popupfenster handelt und ob auf die HTML-Themendatei über eine Kontext-ID, eine HTML-Hilfe-URLoder einen KLink-Suchvorgang (Keyword Link) 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-aufgerufen wird. Das Hilfefenster gehört diesem Fenster.
Wenn das Hilfefenster geschlossen ist, gibt HtmlHelp- den 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 HtmlHelp darüber hinaus Benachrichtigungen aus dem Hilfefenster sendet, werden sie an hwndCaller gesendet, solange Sie Benachrichtigungsnachricht aktiviert haben, Nachverfolgung in der Definition des Hilfefensters.
[in] pszFile
Gibt abhängig vom uCommand--Wert den Dateipfad an, entweder zu einer kompilierten Hilfedatei (.chm) oder einer Themendatei innerhalb einer angegebenen Hilfedatei.
Ein Fenstertyp Name kann auch angegeben werden, vorangestellt mit einem Zeichen größer als (>).
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
Je nach dem angegebenen uCommand- und dem Ergebnis gibt HtmlHelp- einen oder beide der folgenden Werte zurück:
- Der 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.
Bemerkungen
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 hosten ausführbaren Datei auf mindestens 100k fest. Wenn die definierte Stapelgröße zu klein ist, wird auch der zum Ausführen der HTML-Hilfe erstellte Thread mit dieser Stapelgröße erstellt, und ein Fehler kann dazu führen. Optional können Sie /STACK aus der Befehlszeile des Links entfernen 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 Befehl "/Fnumber compiler" festlegen (der Compiler übergibt dies an den Linker als /STACK).
Beispiele
Im folgenden Beispiel wird der Befehl HH_DISPLAY_TOPIC aufgerufen, um die Hilfedatei mit dem Namen "Help.chm" zu öffnen und das Standardthema im Hilfefenster mit dem Namen "Mainwin" anzuzeigen. Im Allgemeinen ist das in diesem Befehl angegebene Hilfefenster ein Standard-HTML-Hilfe-Viewer.
HWND hwnd =
HtmlHelp(
GetDesktopWindow(),
"c:\\Help.chm::/Intro.htm>Mainwin",
HH_DISPLAY_TOPIC,
NULL) ;
Anmerkung
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- | Fenster |
| Header- | htmlhelp.h |
| Library | Htmlhelp.lib |
| DLL- | hhctrl.ocx |