Aide:Include.txt

Document original V3.3.6.1 :

###Keyword###
#include

###Description###
Includes a file in the current script.

###Syntax###
<b>#include</b> "[path\]filename"
<b>#include</b> &lt;filename&gt;


###Parameters###
@@ParamTable@@
filename
	The filename of the current script to include. Path is optional. <b>This must be a string--it cannot be a variable.</b>
	If <b>"..."</b> is used, the filename is taken to be relative to the current script.
	If <b>&lt;...&gt;</b> is used the filename is taken to be relative to include library directory (usually C:\Program Files\AutoIt3\Include).  The include library contains many pre-written user-functions for you to use!
 @@End@@

###Remarks###
In an AutoIt script, other scripts can be included using the #include" command.

If you include the same file containing a user-function more than once you will get a "Duplicate function" error.  When writing an include file that may be used in this way, make sure that the top line contains <b>#include-once</b> to prevent that file from being included more than once.

There is a special registry value that can be created at "HKEY_CURRENT_USER\Software\AutoIt v3\AutoIt" called "Include".  It should be a REG_SZ (string) value.  The contents of this value are a semi-colon delimited list of directories that should be searched for files when resolving #include's in addition to the standard locations.

The search order used by AutoIt depends on which form of #include you use.  The tables below show the order directories are searched using both forms.

Using #include <>
@@ParamTable@@
Standard library
	The path of the currently running interpreter with "\Include" appended is searched.
User-defined libraries
	The registry value mentioned above is read and each directory is searched in the order they appear in.
Script directory
	The directory of the currently executing script.
@@End@@

Using #include "" (This is the reverse of #include <>).
@@ParamTable@@
Script directory
	The directory of the currently executing script.
User-defined libraries
	The registry value mentioned above is read and each directory is searched in the reverse order they appear in.
Standard library
	The path of the currently running interpreter with "\Include" appended is searched.
@@End@@

A note about using the /AutoIt3ExecuteScript option.  Since the standard library is searched for in the current interpreter's directory, the standard library functions will not be found; that library will only be found when run through AutoIt3.exe.  It's recommended that you compile a script to the .a3x format before attempting to run it with /AutoIt3ExecuteScript.

Aut2Exe uses the same algorithm as AutoIt3.exe with the only difference being it looks for the Include sub-directory as being in a sibling directory to itself (..\Include).

If Opt("TrayIconDebug",1) only 64 include files name can be displayed in the traytooltip. for the other no filename will be displayed.

###Related###
<a href="include-once.htm">#include-once</a>


###Example###
@@IncludeExample@@

Document traduit V3.3.6.1 :

###Keyword###
#include

###Description###
Inclut un fichier dans le script en cours.


###Syntax###
<b>#include</b> "[path\]filename"
<b>#include</b> &lt;filename&gt;


###Parameters###
@@ParamTable@@
filename
	Le nom du fichier à inclure. Le chemin est optionnel. <b>Ce être une chaîne de caractères -- Cela ne peut être une variable.</b>
	Si <b>"..."</b> est utilisé, le nom du fichier est cherché de manière relative à partir du répertoire courant du script en cours.
	Si <b>&lt;...&gt;</b> est utilisé, le nom du fichier est cherché de manière relative à partir du répertoire contenant la libraire des fichiers d'inclusion (habituellement C:\Program Files\AutoIt3\Include).  Cette librairie contient beaucoup de fonctions utilisateur pré-écrites et prêtes à vous servir !
 @@End@@


###Remarks###
Dans un script AutoIt, d'autres scripts peuvent être inclus en utilisant la commande "#include".

Si vous incluez le même fichier contenant une fonction utilisateur plus d'une fois, vous aurez une erreur "Duplicate function". Lors de l'écriture d'un fichier include qui sera utilisé de cette manière, n'oubliez pas de rajouter dans les premières lignes <b>#include-once</b> pour éviter que ce fichier ne soit inclut plus d'une fois.

Il existe une valeur spéciale dans le registre qui peut être créée dans "HKEY_CURRENT_USER\Software\AutoIt v3\AutoIt" appelée "Include". Elle doit être une valeur (de chaîne) REG_SZ. Le contenu de cette valeur est une liste de répertoires séparés par une virgule, dans lesquels les fichiers seront recherchés lors d'un #include, en plus des localisations standard.     

L'ordre de recherche utilisé par AutoIt dépend du format utilisez pour #include. Le tableau ci-dessous montre l'ordre de recherche des répertoires pour les deux formats.

Utilisation de  #include <>
@@ParamTable@@
Standard library
  Le chemin de l'interpréteur en cours avec "\Include" ajouté à la fin, est cherché.
User-defined libraries
	La valeur du registre mentionné ci-dessus est lue et chaque répertoire est recherché suivant l'ordre d'apparition (dans cette valeur).
Script directory
	Le répertoire du script en cours.
@@End@@

Utilisation de  #include "" (En opposition à #include <>).
@@ParamTable@@
Script directory
	Le répertoire du script en cours.
User-defined libraries
	La valeur du registre mentionné ci-dessus est lue et chaque répertoire est recherché suivant l'ordre d'apparition (dans cette valeur).
Standard library
	Le chemin de l'interpréteur en cours avec "\Include" ajouté à la fin, est cherché.
@@End@@

Note à propos de l'utilisation de l'option /AutoIt3ExecuteScript. Depuis que la libraire standard est cherchée dans le répertoire de l'interpréteur courant, les fonctions de la librairie standard ne seront pas trouvées; cette librairie ne sera trouvée qu'avec l'utilisation de AutoIt3.exe. Il est donc recommandé de compiler le script au format .a3x avant de le lancer avec /AutoIt3ExecuteScript.

Aut2Exe utilise le même algorithme qu'AutoIt3.exe avec pour seule différence qu'il cherche le sous-répertoire Include dans un répertoire parent à lui même (..\Include).


Si Opt("TrayIconDebug",1) est utilisé, seulement 64 noms de fichiers include seront affichés dans la bulle d'info de la barre des tâche. Pour les autres, aucun nom de fichier ne sera affiché.


###Related###
<a href="include-once.htm">#include-once</a>


###Example###
@@IncludeExample@@

Traducteur : jbnh

Contributeurs (pour les modifications avant le Wiki) : sylvanie, jerome, Tlem