Fonction WinHelpA (winuser.h)
Lance l’aide Windows (Winhelp.exe) et transmet des données supplémentaires qui indiquent la nature de l’aide demandée par l’application.
Syntaxe
BOOL WinHelpA(
HWND hWndMain,
LPCSTR lpszHelp,
UINT uCommand,
ULONG_PTR dwData
);
Paramètres
hWndMain
Type : HWND
Handle vers la fenêtre demandant de l’aide. La fonction WinHelp utilise ce handle pour suivre les applications qui ont demandé de l’aide. Si le paramètre uCommand
lpszHelp
Type : LPCTSTR
Adresse d’une chaîne terminée par null contenant le chemin d’accès, le cas échéant, et le nom du fichier d’aide qui WinHelp doit s’afficher.
Le nom de fichier peut être suivi d’un crochet angle (>) et du nom d’une fenêtre secondaire si la rubrique doit être affichée dans une fenêtre secondaire plutôt que dans la fenêtre primaire. Vous devez définir le nom de la fenêtre secondaire dans la section [WINDOWS] du fichier du projet d’aide (.hpj).
uCommand
Type : uiNT
Type d’aide demandé. Pour obtenir la liste des valeurs possibles et leur impact sur la valeur à placer dans le paramètre dwData, consultez la section Remarques.
dwData
Type : ULONG_PTR
Données supplémentaires. La valeur utilisée dépend de la valeur du paramètre uCommand. Pour obtenir la liste des valeurs possibles dwData, consultez la section Remarques.
Valeur de retour
Type : BOOL
Retourne une valeur différente de zéro si elle réussit ou zéro dans le cas contraire. Pour récupérer des informations d’erreur étendues, appelez GetLastError.
Remarques
Avant de fermer la fenêtre qui a demandé de l’aide, l’application doit appeler WinHelp avec le paramètre uCommand défini sur HELP_QUIT. Tant que toutes les applications n’ont pas effectué cette opération, l’aide de Windows ne se termine pas. Notez que l’appel de l’aide windows avec la commande HELP_QUIT n’est pas nécessaire si vous avez utilisé la commande HELP_CONTEXTPOPUP pour démarrer l’aide de Windows.
Cette fonction échoue si elle est appelée à partir d’un contexte, mais l’utilisateur actuel.
Le tableau suivant présente les valeurs possibles pour le paramètre uCommand
| uCommand | Action | dwData |
|---|---|---|
| HELP_COMMAND | Exécute une macro d’aide ou une chaîne de macro. | Adresse d’une chaîne qui spécifie le nom des macros d’aide à exécuter. Si la chaîne spécifie plusieurs noms de macros, les noms doivent être séparés par des points-virgules. Vous devez utiliser la forme abrégée du nom de macro pour certaines macros, car l’aide de Windows ne prend pas en charge le nom long. |
| HELP_CONTENTS | Affiche la rubrique spécifiée par l’option Contenu dans la section [OPTIONS] du fichier .hpj. Cette commande est destinée à la compatibilité descendante. Les nouvelles applications doivent fournir un fichier .cnt et utiliser la commande HELP_FINDER. | Ignoré; défini sur 0. |
| HELP_CONTEXT | Affiche la rubrique identifiée par l’identificateur de contexte spécifié défini dans la section [MAP] du fichier .hpj. | Contient l’identificateur de contexte de la rubrique. |
| HELP_CONTEXTMENU | Affiche le menu Aide de la fenêtre sélectionnée, puis affiche la rubrique du contrôle sélectionné dans une fenêtre contextuelle. | Adresse d’un tableau de paires d'DWORD. La première DWORD dans chaque paire est l’identificateur de contrôle, et la seconde est l’identificateur de contexte de la rubrique. Le tableau doit être arrêté par une paire de zéros {0,0}. Si vous ne souhaitez pas ajouter d’aide à un contrôle particulier, définissez son identificateur de contexte sur -1. |
| HELP_CONTEXTPOPUP | Affiche la rubrique identifiée par l’identificateur de contexte spécifié défini dans la section [MAP] du fichier .hpj dans une fenêtre contextuelle. | Contient l’identificateur de contexte d’une rubrique. |
| HELP_FINDER | Affiche la boîte de dialogue Rubriques d’aide. | Ignoré; défini sur 0. |
| HELP_FORCEFILE | Garantit que l’aide Windows affiche le fichier d’aide approprié. Si le fichier d’aide incorrect s’affiche, l’aide de Windows s’ouvre correctement ; sinon, il n’y a aucune action. | Ignoré; défini sur 0. |
| HELP_HELPONHELP | Affiche de l’aide sur l’utilisation de l’aide Windows si le fichier Winhlp32.hlp est disponible. | Ignoré; défini sur 0. |
| HELP_INDEX | Affiche la rubrique spécifiée par l’option Contenu dans la section [OPTIONS] du fichier .hpj. Cette commande est destinée à la compatibilité descendante. Les nouvelles applications doivent utiliser la commande HELP_FINDER. | Ignoré; défini sur 0. |
| HELP_KEY | Affiche la rubrique dans la table de mots clés qui correspond au mot clé spécifié, s’il existe une correspondance exacte. S’il existe plusieurs correspondances, affiche l’index avec les rubriques répertoriées dans la zone de liste Rubriques trouvées zone de liste. | Adresse d’une chaîne de mot clé. Plusieurs mots clés doivent être séparés par des points-virgules. |
| HELP_MULTIKEY | Affiche la rubrique spécifiée par un mot clé dans une autre table de mots clés. | Adresse d’une structure MULTIKEYHELP qui spécifie un caractère de note de bas de page de table et un mot clé. |
| HELP_PARTIALKEY | Affiche la rubrique dans la table de mots clés qui correspond au mot clé spécifié, s’il existe une correspondance exacte. S’il existe plusieurs correspondances, affiche la boîte de dialogue Rubriques trouvées. Pour afficher l’index sans passer de mot clé, utilisez un pointeur vers une chaîne vide. | Adresse d’une chaîne de mot clé. Plusieurs mots clés doivent être séparés par des points-virgules. |
| HELP_QUIT | Informe l’aide de Windows qu’elle n’est plus nécessaire. Si aucune autre application n’a demandé de l’aide, Windows ferme l’aide windows. | Ignoré; défini sur 0. |
| HELP_SETCONTENTS | Spécifie la rubrique Contenu. L’aide Windows affiche cette rubrique lorsque l’utilisateur clique sur le bouton Contenu si le fichier d’aide n’a pas de fichier .cnt associé. | Contient l’identificateur de contexte de la rubrique Contenu. |
| HELP_SETPOPUP_POS | Définit la position de la fenêtre contextuelle suivante. | Contient les données de position. Utilisez MAKELONG pour concaténer les coordonnées horizontales et verticales en une seule valeur. La fenêtre contextuelle est positionnée comme si le curseur de la souris se trouvait au point spécifié lorsque la fenêtre contextuelle a été appelée. |
| HELP_SETWINPOS | Affiche la fenêtre d’aide Windows, si elle est réduite ou en mémoire, et définit sa taille et sa position comme spécifié. | Adresse d’une structure HELPWININFO qui spécifie la taille et la position d’une fenêtre d’aide primaire ou secondaire. |
| HELP_TCARD | Indique qu’une commande est destinée à une instance de carte d’apprentissage de l’aide Windows. Combinez cette commande avec d’autres commandes à l’aide de l’opérateur OR au niveau du bit. | Dépend de la commande avec laquelle cette commande est combinée. |
| HELP_WM_HELP | Affiche la rubrique du contrôle identifié par le paramètre hWndMain dans une fenêtre contextuelle. | Adresse d’un tableau de paires d'DWORD. La première DWORD dans chaque paire est un identificateur de contrôle, et la seconde est un identificateur de contexte pour une rubrique. Le tableau doit être arrêté par une paire de zéros {0,0}. Si vous ne souhaitez pas ajouter d’aide à un contrôle particulier, définissez son identificateur de contexte sur -1. |
Note
L’en-tête winuser.h définit WinHelp comme 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.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Windows XP [applications de bureau uniquement] |
| serveur minimum pris en charge | Windows 2000 Server [applications de bureau uniquement] |
| plateforme cible | Windows |
| d’en-tête | winuser.h |
| bibliothèque | User32.lib |
| DLL | User32.dll |
| ensemble d’API | ext-ms-win-ntuser-misc-l1-5-1 (introduit dans Windows 10, version 10.0.14393) |