Fonction HtmlHelpW (htmlhelp.h)

Article
02/26/2024

Affiche une fenêtre d’aide.

À l’aide des commandes d’API, vous pouvez spécifier la rubrique à afficher dans la fenêtre d’aide, si la fenêtre d’aide est une visionneuse d’aide à trois volets ou une fenêtre contextuelle, et si le fichier de rubrique HTML doit être accessible via un ID de contexte, une URL d’aide HTML ou une recherche de lien de mot clé (KLink).

Syntaxe

HWND HtmlHelpW(
  [in, optional] HWND      hwndCaller,
  [in]           LPCWSTR   pszFile,
  [in]           UINT      uCommand,
  [in]           DWORD_PTR dwData
);

Paramètres

[in, optional] hwndCaller

Spécifie le handle (hwnd) de la fenêtre appelant HtmlHelp. La fenêtre d’aide appartient à cette fenêtre.

Lorsque la fenêtre d’aide est fermée, HtmlHelp renvoie le focus sur le propriétaire, sauf si le propriétaire est le bureau. Si hwndCaller est le bureau, le système d’exploitation détermine où le focus est retourné.

En outre, si HtmlHelp envoie des messages de notification à partir de la fenêtre d’aide, ils sont envoyés à hwndCaller tant que vous avez activé le suivi des messages de notification dans la définition de la fenêtre d’aide.

[in] pszFile

En fonction de la valeur uCommand , spécifie le chemin d’accès au fichier d’aide compilé (.chm) ou à un fichier de rubrique dans un fichier d’aide spécifié.

Un nom de type de fenêtre peut également être spécifié, précédé d’un caractère supérieur à (>).

Si la commande spécifiée ne nécessite pas de fichier, cette valeur peut être NULL.

[in] uCommand

Spécifie la commande à effectuer.

[in] dwData

Spécifie toutes les données qui peuvent être requises, en fonction de la valeur du paramètre uCommand .

Valeur retournée

En fonction de l’uCommand spécifié et du résultat, HtmlHelp retourne l’un des éléments suivants ou les deux :

Handle (hwnd) de la fenêtre d’aide.
NULL. Dans certains cas, NULL indique un échec ; dans d’autres cas, null indique que la fenêtre d’aide n’a pas encore été créée.

Remarques

La syntaxe s’applique aux jeux de caractères ANSI. Lorsque vous utilisez un jeu de caractères Unicode, le type du paramètre pszFile doit être « LPCTSTR ».

Lorsque vous utilisez l’API d’aide HTML, définissez la taille de la pile de l’exécutable d’hébergement sur au moins 100 000. Si la taille de pile définie est trop petite, le thread créé pour exécuter l’aide HTML sera également créé avec cette taille de pile, et un échec peut se produire. Si vous le souhaitez, vous pouvez supprimer /STACK de la ligne de commande de lien et supprimer tout paramètre STACK dans le fichier DEF de l’exécutable (la taille de la pile par défaut est de 1 Mo dans ce cas). Vous pouvez également définir la taille de la pile à l’aide de la commande du compilateur /Fnumber (le compilateur la transmet à l’éditeur de liens en tant que /STACK).

Exemples

L’exemple suivant appelle la commande HH_DISPLAY_TOPIC pour ouvrir le fichier d’aide nommé Help.chm et afficher sa rubrique par défaut dans la fenêtre d’aide nommée Mainwin. En règle générale, la fenêtre d’aide spécifiée dans cette commande est une visionneuse d’aide HTML standard.

HWND hwnd =
   HtmlHelp(
            GetDesktopWindow(),
            "c:\\Help.chm::/Intro.htm>Mainwin",
            HH_DISPLAY_TOPIC,
            NULL) ;

Notes

L’en-tête htmlhelp.h définit HtmlHelp comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise	Valeur
Plateforme cible	Windows
En-tête	htmlhelp.h
Bibliothèque	Htmlhelp.lib
DLL	hhctrl.ocx

Voir aussi

À propos de l’API d’aide HTML

Partager via