Esta parte de la documentación muestra los comandos del lenguaje AdvPL.
Cada comando se presentará por medio de diversos tópicos listados en la siguiente tabla.
Tópico | Contenido |
Comando | Palabra clave o nombre que identifica el comando. |
Sintaxis | Define de manera esquemática la forma y las reglas para utilizar el comando. |
Propósito | Describe el objetivo principal o propósito del comando. |
Argumentos | Define el significado y la forma de utilizar cada cláusula o argumento del comando. |
Utilización | Presenta conceptos para aplicar el comando y describe como utilizarlo. |
Sugerencias | Muestra caminos y sugerencias interesantes para aplicar el comando. |
Ejemplo | Ejemplos genéricos, útiles para entender la aplicación y utilización del comando. |
Vea también | Presenta una lista de otros comandos o funciones listados para consulta. |
Notación y convenciones de sintaxis
Para mostrar y explicar los comandos y funciones del AdvPL, utilizaremos un tipo de notación estándar y tradicional. A continuación presentamos las convenciones y símbolos de esta notación:
- Las palabras clave que identifican los comandos y funciones del AdvPL siempre se escriben con letra mayúscula. Por ejemplo: BEGIN SEQUENCE.
- Directivas para el compilador siempre se presentan con letras minúsculas, precedidas por el símbolo # (numeral). Por ejemplo: #include.
- La parte de los comandos que el lector debe informar aparecerá entre los signos menor y mayor ( < > ) y estará en letras minúsculas. Por ejemplo: IF <condición>.
- Los signos < y > no forman parte del sintaxis del comando o función, y se utilizan sólo para representar la información que el lector debe suplir.
- Los argumentos de las funciones que el lector debe informar se especifican entre paréntesis ( ), separados por comas y siempre estarán en letras minúsculas. Por ejemplo: SQRT(<expresión numérica>).
- Las cláusulas opcionales de algunos comandos o argumentos opcionales de algunas funciones se presentan entre corchetes [ ]. Esto significa que el lector puede incluir o no esta parte del comando o función, ya que ella es opcional. Con excepción de la declaración de los array, los corchetes no forman parte de la sintaxis de los comandos o funciones, puesto que se utilizan sólo para representar la parte que puede ser opcionalmente informada por el lector.
- Un bloque de código o matriz se representan entre llaves { }. Por ejemplo:
- { | x | x + 1 }
- aMat := { 1, 2, 3 }
- La lista de argumentos utilizados en bloques de código se debe especificar entre barras verticales | |.
- La coma se utilizará para separar múltiples cláusulas o argumentos contenidos en la sintaxis de comandos o funciones.
- El símbolo arroba ( @ ) indicará que un argumento se debe pasar a una función por referencia.
- Las opciones alternativas de algunos comandos se indicarán por medio de la barra inclinada ( / ).
- Cláusulas repetitivas o extensas se indicarán por reticencias ( ... ). Por ejemplo: IF ... ELSEIF ... ELSEIF ... ELSE ... ENDIF.
- Los nombres de las rutinas definidas por el programador, es decir, funciones que no pertenecen al AdvPL, tendrán la primera letra de su nombre en letra mayúscula y las demás en letras minúsculas. Por ejemplo: Calcmed().
- Comandos o funciones obsoletos se presentarán con un asterisco después de su nombre. Por ejemplo: RECCOUNT()*.
- Los nombres de archivos estarán en letras mayúsculas. Por ejemplo: MATA020.PRW.
- Extensiones de nombres de archivos se iniciarán con un punto y estarán escritas con letras mayúsculas. Por ejemplo: .PRW.
Primero mostraremos los comandos en orden alfabética. Sin embargo, al final de la documentación existe un tópico que agrupa los comandos por funcionalidad.