Changes between Initial Version and Version 1 of fr:Documentation/ARexxAPI


Ignore:
Timestamp:
Oct 1, 2013 8:07:07 PM (10 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • fr:Documentation/ARexxAPI

    v1 v1  
     1== Référence - Interface ARexx 
     2 
     3À l'aide de scripts ARexx vous pouvez ajouter de nouvelles fonctions 
     4à YAM ou bien lui laissé effectuer des fonctions automatiquement. YAM offre 
     5un [[rexx| ensemble de commandes ]], qui peuvent être appelées à travers 
     6le port ARexx « YAM ». Il y aura des explications tout au long des 
     7sous-chapitres en utilisant le format suivant : 
     8 
     9 
     10 
     11'''NOM''' 
     12     Le nom de la commande, une courte description de ce qu'elle fait et 
     13     la version de YAM depuis laquelle elle est implémentée. 
     14 
     15'''SYNTAXE''' 
     16     Les arguments et options acceptés par la commande. La syntaxe utilise 
     17     des caractères spéciaux pour indiquer le type particulier de l'argument 
     18     attendu, en suivant le style de l'AmigaOS : 
     19 
     20     /A   Le paramètre est facultatif\\ 
     21     /K   Le paramètre doit être précédé du mot clé\\ 
     22     /N   Argument ou résultat numérique\\ 
     23     /M   L'argument ou le résultat est une liste composée (de zéro à plus) éléments\\ 
     24     /S   Le paramètre fonctionne comme un interrupteur ; il est activé quand il est mentionné.\\ 
     25 
     26'''FONCTION''' 
     27     Donne une description de la commande. 
     28 
     29'''ENTREE''' 
     30     Décrit en détail les paramètres acceptés par la commande. 
     31     Prenez garde lorsque vous passez des arguments contenant des 
     32     espaces. Par exemple : 
     33 
     34          sub = 'Hello World'\\ 
     35          'WRITESUBJECT' sub\\ 
     36 
     37     ne fonctionnera pas ! Il aurait fallu écrire : 
     38 
     39          'WRITESUBJECT "'sub'"' 
     40 
     41     ou 
     42 
     43          'WRITESUBJECT "Hello World"' 
     44 
     45 
     46     Veuillez noter qu'à cause de l'utilisation en interne de la fonction 
     47     ReadArgs(), l'hôte ARexx nécessite l'échappement de certains caractères 
     48     spéciaux comme un retour à la ligne (0x0a) ou le caractère d'échappement 
     49     (0x1b) si vous voulez qu'il soit inclus dans votre chaine finale, dans le 
     50     cas contraire, il sera éliminé par la fonction ReadArgs(). 
     51 
     52     Cela signifie que vous devez utiliser les séquences d'échappement 
     53     suivantes dans vos chaines de caractères : 
     54 
     55     *N remplace 0x0a\\ 
     56     *E remplace 0x1b\\ 
     57     !** remplace *\\ 
     58     *" remplace "\\ 
     59 
     60     Par exemple la commande suivante écrit un chaine de caractère contenant 
     61     un retour à la ligne dans l'éditeur : 
     62 
     63     'WRITEEDITOR "TEXT Bonjour Joe,*N je voudrais vous rencontrer."' 
     64 
     65'''RESULTAT''' 
     66     Retourne un résultat attendu. 
     67     Les commandes peuvent retourner un résultat de trois manières différentes. 
     68     Jetez un oeil aux ''exemples'' qui utilisent la commande FOLDERINFO : 
     69 
     70          FOLDERINFO 
     71            -> RESULT = "0 Reçus incoming 10 2 4 23030 1" 
     72 
     73          FOLDERINFO VAR fi 
     74            -> fi = "0 Reçus incoming 10 2 4 23030 1" 
     75 
     76          FOLDERINFO STEM fi. 
     77            -> fi.number = 0 
     78               fi.name = "Reçus"\\ 
     79               fi.path = "incoming"\\ 
     80               fi.total = 10\\ 
     81               fi.new = 2\\ 
     82               fi.unread = 4\\ 
     83               fi.size = 23030\\ 
     84               fi.type = 1\\ 
     85 
     86     Un autre exemple qui retourne un résultat de type /M : 
     87 
     88          ADDRFIND STEM found. "Marcel Beck" NAMEONLY 
     89            -> found.alias.count = 2 
     90               found.alias.0 = "Mars"\\ 
     91               found.alias.1 = "mbe"\\ 
     92 
     93'''ATTENTION''' 
     94     Toutes sortes d'informations auxquelles il faut prêter attention en 
     95     utilisant cette commande. 
     96 
     97'''NOTES''' 
     98     Remarques variées sur la commande. 
     99 
     100'''EXEMPLE''' 
     101     Un bout de code ARexx pour illustrer l'utilisation de la commande. 
     102 
     103'''BUGS''' 
     104     Problèmes connus ou corrigés avec cette commande. 
     105 
     106'''VOIR AUSSI''' 
     107     Liens relatifs à d'autres commandes. 
     108 
     109---- 
     110 * [[rexx| Liste des commandes ARexx par ordre alphabétique    ]] 
     111 * [[rexl| Liste de toutes les commandes ARexx triées par thème ]]