HtmlHelpW, fonction (htmlhelp.h)

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 retourne 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é message de notification suivi dans la définition de la fenêtre d’aide.

[in] pszFile

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

Un type de fenêtre nom 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 à terminer.

[in] dwData

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

Valeur de retour

En fonction de l' uCommand spécifié et du résultat, HtmlHelp retourne l’une ou l’autre des deux valeurs suivantes :

• Handle (hwnd) de la fenêtre d’aide.
• NULL. Dans certains cas, NULL indique l’é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 pile de l’exécutable d’hébergement sur au moins 100 000 ko. Si la taille de pile définie est trop petite, le thread créé pour exécuter l’aide HTML est également créé avec cette taille de pile et l’échec peut entraîner un résultat. Si vous le souhaitez, vous pouvez supprimer /STACK de la ligne de commande du lien et supprimer n’importe quel 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 le 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) ;

Exigences

Voir aussi

À propos de l’API d’aide HTML