wiki:fr:Documentation/ARexxAPI

Version 11 (modified by AmigaPhil, 9 months ago) (diff)

--

Autres langues:

ARexx Function List

  1. ADDRDELETE

Référence - Interface ARexx

À l'aide de scripts ARexx vous pouvez ajouter de nouvelles fonctions à YAM ou bien lui laissé effectuer des fonctions automatiquement. YAM offre un ensemble de commandes (listées par nom et par fonction), qui peuvent être appelées à travers le port ARexx « YAM ». Il y aura des explications tout au long des sous-chapitres en utilisant le format suivant :

NOM
Le nom de la commande, une courte description de ce qu'elle fait et la version de YAM depuis laquelle elle est implémentée.
SYNTAXE
Les arguments et options acceptés par la commande. La syntaxe utilise des caractères spéciaux pour indiquer le type particulier de l'argument attendu, en suivant le style de l'AmigaOS :

/A Le paramètre est facultatif
/K Le paramètre doit être précédé du mot clé
/N Argument ou résultat numérique
/M L'argument ou le résultat est une liste composée (de zéro à plus) éléments
/S Le paramètre fonctionne comme un interrupteur ; il est activé quand il est mentionné.

FONCTION
Donne une description de la commande.
ENTREE
Décrit en détail les paramètres acceptés par la commande. Prenez garde lorsque vous passez des arguments contenant des espaces. Par exemple :
sub = 'Hello World'
'WRITESUBJECT' sub

ne fonctionnera pas. Il aurait fallu écrire :

'WRITESUBJECT "'sub'"'

ou

'WRITESUBJECT "Hello World"'

Veuillez noter qu'à cause de l'utilisation en interne de la fonction ReadArgs(), l'hôte ARexx nécessite l'échappement de certains caractères spéciaux comme un retour à la ligne (0x0a) ou le caractère d'échappement (0x1b) si vous voulez qu'il soit inclus dans votre chaine finale, dans le cas contraire, il sera éliminé par la fonction ReadArgs().

Cela signifie que vous devez utiliser les séquences d'échappement suivantes dans vos chaines de caractères :

*N remplace 0x0a
*E remplace 0x1b
** remplace *
*" remplace "

Par exemple la commande suivante écrit un chaine de caractère contenant un retour à la ligne dans l'éditeur :

'WRITEEDITOR "TEXT Bonjour Joe,*N je voudrais vous rencontrer."'

Si un paramètre représente un nom de fichier, vous devez garder à l'esprit que les noms de fichier sous AmigaOS peuvent contenir des espacements ou autres caractères spéciaux qui ferant qu'ARexx traitera le nom comme plusieurs mots au lieu d'un seul mot. De ce fait, un nom de fichier devrait toujours être entouré de guillemets ("), qu'importe qu'il contient des espaces ou pas. Les scripts peuvent facilement être testés pour ce cas en procurant un fichier du disque RAM; par exemple "RAM Disk:/foo/bar".

RESULTAT
Retourne un résultat attendu. Les commandes peuvent retourner un résultat de trois manières différentes. Jetez un oeil aux exemples qui utilisent la commande FOLDERINFO :
FOLDERINFO
  -> RESULT = "0 Reçus incoming 10 2 4 23030 1"
FOLDERINFO VAR fi
  -> fi = "0 Reçus incoming 10 2 4 23030 1"
FOLDERINFO STEM fi.
  -> fi.number = 0
     fi.name = "Reçus"
     fi.path = "incoming"
     fi.total = 10               
     fi.new = 2
     fi.unread = 4
     fi.size = 23030
     fi.type = 1

Un autre exemple qui retourne un résultat de type /M :

ADDRFIND STEM found. "Marcel Beck" NAMEONLY
  -> found.alias.count = 2
     found.alias.0 = "Mars"
     found.alias.1 = "mbe"
ATTENTION
Toutes sortes d'informations auxquelles il faut prêter attention en utilisant cette commande.
NOTES
Remarques variées sur la commande.
EXEMPLE
Un bout de code ARexx pour illustrer l'utilisation de la commande.
BUGS
Problèmes connus ou corrigés avec cette commande.
VOIR AUSSI
Liens relatifs à d'autres commandes.

Liste des commandes ARexx groupées par fonction

Commandes founies par MUI

HELP? - Affiche une liste de toutes les commandes ARexx supportées.
HIDE? - Icônifie YAM.
INFO? - Affiche les informations sur le programme.
QUIT? - Quitte YAM.
SCREENTOBACK? - Place l'écran de YAM en arrière plan.
SCREENTOFRONT? - Place l'écran de YAM au premier plan.
SHOW? - Désicônifie YAM.

Gestion du carnet d'adresses

ADDRDELETE - Supprime une entrée du carnet d'adresses.
ADDREDIT? - Rempli les champs de l'entrée actuelle du carnet d'adresses.
ADDRFIND? - Recherche une entrée dans le carnet d'adresses.
ADDRGOTO? - Sélectionne une entrée du carnet d'adresses avec alias.
ADDRINFO? - Retourne les informations d'une entrée référencée par un alias.
ADDRLOAD? - Charge un carnet d'adresses avec son nom de fichier.
ADDRNEW? - Crée une nouvelle entrée dans le carnet d'adresses.
ADDRRESOLVE? - Retrouve un alias ou un nom.
ADDRSAVE? - Sauve le carnet d'adresses sous un nom donné.

Opérations générales sur les dossiers

FLUSHINDEXES?  - Libérer les indexs de tous les dossiers.
FOLDERINFO? - Retourne les informations sur le dossier donné.
GETFOLDERINFO? - Retourne les informations sur le dossier en cours.
MAILFILTER? - Filtre les messages du dossier en cours.
MAILUPDATE? - Met à jour l'index du dossier en cours.
NEWMAILFILE? - Retourne la zone de message libre pour un dossier donné.

Gestion de l'interface

APPBUSY? - Place YAM en mode occupé.
APPNOBUSY? - Place YAM en mode disponible (non-occupé).
LISTFREEZE?  - Désactive les mises à jour graphique d'une liste.
LISTUNFREEZE?  - Réactive les mises à jour graphique d'une liste.
READCLOSE? - Ferme la fenêtre de lecture active.
RESTART?  - Redémarre YAM

Sélection des messages et dossiers

GETSELECTED? - Donne la position des messages sélectionnées dans le dossier en cours.
LISTSELECT? - Sélectionne les messages du dossier en cours.
SETFOLDER? - sélectionne le dossier en cours.
SETMAIL? - sélectionne le message en cours dans le dossier en cours par son numéro.
SETMAILFILE ? - sélectionne le message en cours dans le dossier en cours par son nom de fichier.

Manipulation des messages

GETMAILINFO? - Affiche les informations sur le message en cours.
MAILARCHIVE? - Déplace les messages sélectionnés vers un autre dossier.
MAILBOUNCE? - Détourne le message actuellement sélectionné.
MAILCHANGESUBJECT? - Change le sujet du/des message(s) sélectionné(s).
MAILCOPY? - Duplique le(s) message(s) sélectionné(s).
MAILDELETE? - Efface le(s) message(s) sélectionné(s).
MAILEDIT? - Édite le message sélectionné.
MAILEXPORT? - Exporte le(s) message(s) sélectionné(s) dans un fichier.
MAILIMPORT? - Importe les messages d'un fichier dans le dossier en cours.
MAILINFO? - Affiche les informations sur un message donné.
MAILMOVE? - Déplace le(s) message(s) sélectionné(s) vers un autre dossier.
MAILREAD? - Lit le message sélectionné.
MAILREPLY? - Répond au message sélectionné.
MAILSTATUS? - Change le statut de(s) message(s) sélectionné(s).
READINFO? - Obtient des informations sur les documents joints dans le message lu.
READPRINT? - Imprime un document joint.
READSAVE? - Sauvegarde un document joint.
SETFLAG? - Active l'état PERmanent ou VOLatile d'un message.

Gestion du réseau

GETURL? - Télécharge un fichier à partir d'une URL de Web donnée.
ISONLINE? - Détecte quand YAM transfère des messages.
MAILCHECK? - Rapatrie les nouveaux messages.
MAILSEND? - Envoie les messages du dossier en attente.
MAILSENDALL? - Envoie tous les messages du dossier en attente.

Informations utilisateur

GETCONFIGINFO? - Affiche les informations sur l'utilisateur en cours.
REQUEST? - Demande à l'utilisateur de faire un choix.
REQUESTFILE?  - Demande à l'utilisateur de sélectionner un fichier.
REQUESTFOLDER? - Demande à l'utilisateur de choisir un dossier.
REQUESTSTRING? - Demande à l'utilisateur une chaîne de caractères.
USERINFO? - Affiche les informations concernant l'utilisateur actuel.

Écrire un nouveau message

MAILFORWARD? - Retransmet le message actuellement sélectionné.
MAILWRITE? - Ouvre une nouvelle fenêtre d'édition pour composer un message.
WRITEATTACH? - Joint un fichier au nouveau message.
WRITEBCC? - Remplit l'en-tête BCC: d'un nouveau message.
WRITECC? - Remplit l'en-tête CC: d'un nouveau message.
WRITEEDITOR? - Passe une commande ARexx à l'éditeur interne.
WRITEFROM? - Remplit l'en-tête FROM: d'un nouveau message.
WRITELETTER? - Charge un fichier texte dans l'éditeur interne.
WRITEMAILTO? - Remplit l'en-tête TO: d'un nouveau message.
WRITEOPTIONS? - Active des options d'un nouveau message.
WRITEQUEUE? - Déplace un nouveau message dans le dossier Outgoing (attente).
WRITEREPLYTO? - Remplit l'en-tête REPLY-TO: d'un nouveau message.
WRITESEND? - Envoi un nouveau message.
WRITESUBJECT? - Remplit l'en-tête SUBJECT: d'un nouveau message.
WRITETO? - Remplit l'en-tête TO: d'un nouveau message.

Liste alphabétique des commandes ARexx

ADDRDELETE - Supprime une entrée du carnet d'adresses.
ADDREDIT? - Rempli les champs de l'entrée actuelle du carnet d'adresses.
ADDRFIND? - Recherche une entrée dans le carnet d'adresses.
ADDRGOTO? - Sélectionne une entrée du carnet d'adresses avec alias.
ADDRINFO? - Retourne les informations d'une entrée référencée par un alias.
ADDRLOAD? - Charge un carnet d'adresses avec son nom de fichier.
ADDRNEW? - Crée une nouvelle entrée dans le carnet d'adresses.
ADDRRESOLVE? - Retrouve un alias ou un nom.
ADDRSAVE? - Sauve le carnet d'adresses sous un nom donné.
APPBUSY? - Place YAM en mode occupé.
APPNOBUSY? - Place YAM en mode disponible (non-occupé).
FLUSHINDEXES?  - Libérer les indexs de tous les dossiers.
FOLDERINFO? - Retourne les informations sur le dossier donné.
GETCONFIGINFO? - Affiche les informations sur l'utilisateur en cours.
GETFOLDERINFO? - Retourne les informations sur le dossier en cours.
GETMAILINFO? - Affiche les informations sur le message en cours.
GETSELECTED? - Donne la position des messages sélectionnées dans le dossier en cours.
GETURL? - Télécharge un fichier à partir d'une URL de Web donnée.
HELP? - Affiche une liste de toutes les commandes ARexx supportées.
HIDE? - Icônifie YAM.
INFO? - Affiche les informations sur le programme.
ISONLINE? - Détecte quand YAM transfère des messages.
LISTFREEZE?  - Désactive les mises à jour graphique d'une liste.
LISTSELECT? - Sélectionne les messages du dossier en cours.
LISTUNFREEZE?  - Réactive les mises à jour graphique d'une liste.
MAILARCHIVE? - Déplace les messages sélectionnés vers un autre dossier.
MAILBOUNCE? - Détourne le message actuellement sélectionné.
MAILCHANGESUBJECT? - Change le sujet du/des message(s) sélectionné(s).
MAILCHECK? - Rapatrie les nouveaux messages.
MAILCOPY? - Duplique le(s) message(s) sélectionné(s).
MAILDELETE? - Efface le(s) message(s) sélectionné(s).
MAILEDIT? - Édite le message sélectionné.
MAILEXPORT? - Exporte le(s) message(s) sélectionné(s) dans un fichier.
MAILFILTER? - Filtre les messages du dossier en cours.
MAILFORWARD? - Retransmet le message actuellement sélectionné.
MAILIMPORT? - Importe les messages d'un fichier dans le dossier en cours.
MAILINFO? - Affiche les informations sur un message donné.
MAILMOVE? - Déplace le(s) message(s) sélectionné(s) vers un autre dossier.
MAILREAD? - Lit le message sélectionné.
MAILREPLY? - Répond au message sélectionné.
MAILSEND? - Envoie les messages du dossier en attente.
MAILSENDALL? - Envoie tous les messages du dossier en attente.
MAILSTATUS? - Change le statut de(s) message(s) sélectionné(s).
MAILUPDATE? - Met à jour l'index du dossier en cours.
MAILWRITE? - Ouvre une nouvelle fenêtre d'édition pour composer un message.
NEWMAILFILE? - Retourne une zone de message libre pour le dossier donné.
QUIT? - Quitte YAM.
READCLOSE? - Ferme la fenêtre de lecture active.
READINFO? - Affiche les informations sur les documents joints dans le message lu.
READPRINT? - Imprime un document joint.
READSAVE? - Sauvegarde un document joint.
REQUEST? - Demande à l'utilisateur de faire un choix.
REQUESTFILE?  - Demande à l'utilisateur de sélectionner un fichier.
REQUESTFOLDER? - Demande à l'utilisateur de choisir un dossier.
REQUESTSTRING? - Demande à l'utilisateur une chaîne de caractères.
RESTART?  - Redémarre YAM
SCREENTOBACK? - Place l'écran de YAM en arrière plan.
SCREENTOFRONT? - Place l'écran de YAM au premier plan.
SETFLAG? - Active l'état PERmanent ou VOLatile d'un message.
SETFOLDER? - sélectionne le dossier en cours.
SETMAIL? - sélectionne le message en cours dans le dossier en cours par son numéro.
SETMAILFILE? - sélectionne le message en cours dans le dossier en cours par son nom de fichier.
SHOW? - Désicônifie YAM.
USERINFO? - Affiche les informations concernant l'utilisateur actuel.
WRITEATTACH? - Joint un fichier au nouveau message.
WRITEBCC? - Remplit l'en-tête BCC: d'un nouveau message.
WRITECC? - Remplit l'en-tête CC: d'un nouveau message.
WRITEEDITOR? - Passe une commande ARexx à l'éditeur interne.
WRITEFROM? - Remplit l'en-tête FROM: d'un nouveau message.
WRITELETTER? - Charge un fichier texte dans l'éditeur interne.
WRITEMAILTO? - Remplit l'en-tête TO: d'un nouveau message.
WRITEOPTIONS? - Active des options d'un nouveau message.
WRITEQUEUE? - Déplace un nouveau message dans le dossier Outgoing (attente).
WRITEREPLYTO? - Remplit l'en-tête REPLY-TO: d'un nouveau message.
WRITESEND? - Envoi un nouveau message.
WRITESUBJECT? - Remplit l'en-tête SUBJECT: d'un nouveau message.
WRITETO? - Remplit l'en-tête TO: d'un nouveau message.