wiki:es:Documentation/ARexxAPI

Version 4 (modified by damato, 11 months ago) (diff)

--

En otros idiomas:

Referencia - Interfaz ARexx

Con la ayuda de scripts ARexx, puede añadir nuevas funciones a YAM, o bien hacerle realizar ciertas cosas de forma automática. YAM ofrece una serie de comandos (organizados en este manual por nombre ? y por función ?) que puede invocar desde el puerto ARexx YAM. Estos comandos se explican detalladamente a lo largo de los siguientes capítulos siguiendo este formato:

NOMBRE

El nombre del comando, con una breve descripción de lo que hace, y la versión de YAM en la que fue implantado por primera vez en caso de no estar presente en YAM 1.0.

PLANTILLA

Argumentos y opciones aceptados por el comando. La plantilla utiliza una serie de caracteres especiales para indicar cada tipo particular de argumento que espera el comando, siguiendo el formato de plantillas comúnmente utilizado por el AmigaDOS:

/A El parámetro es imprescindible
/K El parámetro debe ir precedido de la palabra clave
/N Argumento o resultado numérico
/M El argumento o el resultado es una lista de cero o más elementos
/S El parámetro actúa como un interruptor; el interruptor está activado cuando se indica el parámetro.

FUNCIÓN

Describe con más detalle lo que hace el comando.

ENTRADAS

Describe detalladamente los parámetros que acepta el comando. Tenga cuidado al indicar argumentos que contengan espacios; por ejemplo,

asunto = 'Hola Mundo'
'WRITESUBJECT' asunto

no funcionará. Debe escribirse así:

'WRITESUBJECT "'asunto'"'

o también:

'WRITESUBJECT "Hola Mundo"'

RESULTADOS

Información que hay que esperar recibir del comando. Los comandos pueden devolver resultados de tres formas diferentes; veamos estos ejemplos que utilizan el comando FOLDERINFO:

FOLDERINFO

-> RESULT = "0 Entrantes incoming 10 2 4 23030 1"

FOLDERINFO VAR fi

-> fi = "0 Entrantes incoming 10 2 4 23030 1"

FOLDERINFO STEM fi.

-> fi.number = 0

fi.name = "Entrantes"
fi.path = "incoming"
fi.total = 10
fi.new = 2
fi.unread = 4
fi.size = 23030
fi.type = 1

Otro ejemplo que devuelve un resultado del tipo /M:

ADDRFIND STEM encontrado. "Marcel Beck" NAMEONLY

-> encontrado.alias.count = 2

encontrado.alias.0 = "Mars"
encontrado.alias.1 = "mbe"

AVISO

Cualquier información importante de la que debe ser consciente al utilizar este comando.

NOTAS

Información de interés sobre el funcionamiento del comando.

EJEMPLO

Un fragmento de código ARexx que ilustra el uso correcto del comando.

FALLOS

Problemas que son conocidos o que ya han sido rectificados en el comando.

VÉASE TAMBIÉN

Enlaces a otros comandos relacionados.