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


Ignore:
Timestamp:
Sep 30, 2013 4:42:01 PM (13 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • es:Documentation/ARexxAPI

    v1 v1  
     1== Referencia - Interfaz ARexx 
     2 
     3Con la ayuda de scripts ARexx, puede añadir nuevas funciones a YAM, 
     4o bien hacerle realizar ciertas cosas de forma automática.  YAM ofrece 
     5una serie de comandos (organizados en este manual [[rexx| por nombre ]] y 
     6[[rexl| por función ]]) que puede invocar desde el puerto ARexx '''YAM'''.  Estos 
     7comandos se explican detalladamente a lo largo de los siguientes 
     8capítulos siguiendo este formato: 
     9 
     10 
     11'''NOMBRE''' 
     12     El nombre del comando, con una breve descripción de lo que hace, 
     13     y la versión de YAM en la que fue implantado por primera vez en 
     14     caso de no estar presente en YAM 1.0. 
     15 
     16'''PLANTILLA''' 
     17     Argumentos y opciones aceptados por el comando.  La plantilla 
     18     utiliza una serie de caracteres especiales para indicar cada tipo 
     19     particular de argumento que espera el comando, siguiendo el formato 
     20     de plantillas comúnmente utilizado por el AmigaDOS: 
     21 
     22          /A   El parámetro es imprescindible\\ 
     23          /K   El parámetro debe ir precedido de la palabra clave\\ 
     24          /N   Argumento o resultado numérico\\ 
     25          /M   El argumento o el resultado es una lista de cero o más elementos\\ 
     26          /S   El parámetro actúa como un interruptor; el interruptor está activado cuando se indica el parámetro.\\ 
     27 
     28'''FUNCIÓN''' 
     29     Describe con más detalle lo que hace el comando. 
     30 
     31'''ENTRADAS''' 
     32     Describe detalladamente los parámetros que acepta el comando. 
     33     Tenga cuidado al indicar argumentos que contengan espacios; por 
     34     ejemplo, 
     35 
     36          asunto = 'Hola Mundo'\\ 
     37          'WRITESUBJECT' asunto\\ 
     38 
     39     no funcionará.  Debe escribirse así: 
     40 
     41          'WRITESUBJECT "'asunto'"' 
     42 
     43     o también: 
     44 
     45          'WRITESUBJECT "Hola Mundo"' 
     46 
     47'''RESULTADOS''' 
     48     Información que hay que esperar recibir del comando.  Los 
     49     comandos pueden devolver resultados de tres formas diferentes; 
     50     veamos estos ejemplos que utilizan el comando FOLDERINFO: 
     51 
     52          FOLDERINFO 
     53            -> RESULT = "0 Entrantes incoming 10 2 4 23030 1" 
     54 
     55          FOLDERINFO VAR fi 
     56            -> fi = "0 Entrantes incoming 10 2 4 23030 1" 
     57 
     58          FOLDERINFO STEM fi. 
     59            -> fi.number = 0\\ 
     60               fi.name = "Entrantes"\\ 
     61               fi.path = "incoming"\\ 
     62               fi.total = 10\\ 
     63               fi.new = 2\\ 
     64               fi.unread = 4\\ 
     65               fi.size = 23030\\ 
     66               fi.type = 1\\ 
     67 
     68 
     69     Otro ejemplo que devuelve un resultado del tipo /M: 
     70 
     71          ADDRFIND STEM encontrado. "Marcel Beck" NAMEONLY 
     72            -> encontrado.alias.count = 2 
     73               encontrado.alias.0 = "Mars"\\ 
     74               encontrado.alias.1 = "mbe"\\ 
     75 
     76'''AVISO''' 
     77     Cualquier información importante de la que debe ser consciente 
     78     al utilizar este comando. 
     79 
     80'''NOTAS''' 
     81     Información de interés sobre el funcionamiento del comando. 
     82 
     83'''EJEMPLO''' 
     84     Un fragmento de código ARexx que ilustra el uso correcto del 
     85     comando. 
     86 
     87'''FALLOS''' 
     88     Problemas que son conocidos o que ya han sido rectificados en 
     89     el comando. 
     90 
     91'''VÉASE TAMBIÉN''' 
     92     Enlaces a otros comandos relacionados. 
     93 
     94---- 
     95 * [[rexx|Lista alfabética de todos los comandos ARexx]] 
     96 * [[rexl|Lista de todos los comandos ARexx ordenados por función]]