HELP

Système d'aide

Cette fonction fait appel au système d'aide sur toutes les plate-formes.

Syntaxe : (help [fichier_aide [rubrique [commande]]])

L'argument fichier_aide est une chaîne de caractères (string) qui spécifie le nom d'un fichier d'aide.

Si vous spécifiez un fichier d'aide AutoCAD (.ahp), la fonction (help) utilise la visionneuse d'aide d' AutoCAD pour afficher le contenu du fichier.

Si vous spécifiez un fichier d'aide Windows (.hlp), la fonction (help) utilise le programme standard WinHelp pour afficher le fichier.

Si l'argument fichier_aide est une chaîne vide ou s'il est omis, AutoCAD utilise le fichier d'aide par défaut d' AutoCAD.

L'argument rubrique est un mot-clé qui spécifie la rubrique à afficher
en premier.
Si l'argument rubrique est une chaîne vide (" "), le système d'aide affiche la partie d'introduction du fichier d'aide.

L'argument commande est une chaîne qui spécifie l'état initial de la
fenêtre d'aide, comme indiqué ci-après :

Si vous spécifiez un fichier d'aide Windows, l'argument commande
peut également être une chaîne utilisée par l'argument fuCommand de
la fonction WinHelp() qui est définie dans l'API de WinHelp() dans le
kit de programmation Microsoft Windows SDK.
Il n'est pas nécessaire de spécifier une extension de fichier avec l'argument fichier aide.
Si vous entrez une extension de fichier, AutoCAD recherche uniquement ce fichier, en revanche, si vous omettez l'extension, AutoCAD applique les règles suivantes :
Si vous travaillez dans AutoCAD pour Windows/NT, le programme ajoute l'extension .hlp, sinon, il ajoute l'extension .ahp.
Si AutoCAD ne trouve aucun fichier <fichier>.ahp, il recherche <fichier> sans extension.
Le fichier sans extension est traité en dernier.
En conséquence, sous UNIX, AutoCAD recherche acad.ahp avant acad.
La seule condition d'erreur qui peut être renvoyée par la fonction (help) à l'application est la présence du fichier spécifié par fichier_aide.
Toutes les autres conditions d'erreur vous sont renvoyées dans une
boîte de dialogue.
La fonction (help) renvoie la chaîne fichier_aide en cas de succès, et la valeur nil en cas d'échec.

Si vous utilisez la fonction (help) sans argument, elle renvoie une chaîne vide("") en cas de succès, et nil en cas d'échec.

La ligne suivante appelle la fonction (help) pour enregistrer des informations au sujet de MACOMMANDE dans le fichier d'aide "aideac.ahp" :

(help "aideac.ahp" "macommande")

en cours de création :

Voir aussi Fichiers d'aide personnalisés, pour plus d'informations sur la création des fichiers d'aide AutoCAD.
La fonction setfunhelp permet d'associer une aide contextuelle (lorsque vous  appuyez sur la touche (F1)) à une commande définie par l'utilisateur.

ACAD_HELPDLG

(obsolète)

Cette fonction appelle le système d'aide sur n'importe quelle plate-forme

Syntaxe : (acad_helpdlg fichier_aide rubrique)

Cette fonction externe a été remplacée par la fonction interne (help).Elle est fournie pour assurer la compatibilité avec des versions précédentes d' AutoCAD.

Reportez-vous à "HELP" plus haut dans cette page.

SETFUNHELP

Enregistre une commande que vous définissez à l'aide de la fonction d'aide pour que le fichier et la rubrique d'aide correspondants puissent être appelés lorsque vous demandez de l'aide sur cette commande.

Syntaxe :  (setfunhelp c:nomfonc [fichier_aide [rubrique [commande]]])

L'argument c:nomfonc est une chaîne qui spécifie la commande définie par l'utilisateur (une fonction c: xxx) et qui inclut le préfixe c:.
Contrairement au nom de fonction transmis à la fonction (defun), l'argument fonction de (setfunhelp) doit être une chaîne entre guillemets.
Les trois arguments facultatifs décrivent les modalités de l'appel d'aide.
Il s'agit, là encore, de chaînes qui sont identiques aux arguments transmis à la fonction (help).
La fonction (setfunhelp) renvoie la chaîne transmise au format c:nomfonc en cas de succès et la valeur nil en cas d'échec.
Il n'est pas nécessaire de spécifier une extension de fichier avec l'argument fichier aide.
Si vous entrez une extension de fichier, AutoCAD recherche uniquement ce fichier, en revanche, si vous omettez l'extension, AutoCAD applique les règles suivantes :
Si vous travaillez dans AutoCAD pour Windows/NT, le programme ajoute l'extension .hlp, sinon, il ajoute l'extension .ahp.
Si AutoCAD ne trouve aucun fichier <fichier>.ahp, il recherche <fichier> sans extension.
Le fichier sans extension est traité en dernier.
En conséquence, sous UNIX, AutoCAD recherche acad.ahp avant acad.

Lorsque vous utilisez la fonction (defun) pour définir une fonction c:xxx,
defun supprime le nom de cette fonction de la liste des noms enregistrés par (setfunhelp) (le cas échéant).
De ce fait, setfunhelp ne doit être appelée qu'après un appel à defun, qui établit la commande définie par l'utilisateur.

L'exemple suivant utilise (defun) pour définir la commande utilisateur MAFONC. La fonction (setfunhelp) enregistre le nom de fonction C:MAFONC et associe ce nom à la rubrique mafonc du fichier d'aide monaide.ahp.

1
2
3
4

(defun c:mafonc ()
   (getint "voici: ")
)
(setfunhelp "c:mafonc" "monaide.ahp" "mafonc")

Commande : mafonc
voici: l'aide

En supposant que le fichier d'aide AutoCAD monaide.ahp soit placé sur le chemin d'accès à l'aide, AutoCAD affiche la boîte de dialogue de l'aide avec la rubrique mafonc extraite du fichier monaide.ahp.

Haut de page

revenir aux INCLASSABLES

09 janvier 2018, mise à jour le 20 janvier 2018