Exibir origem

Esta parte de la documentación presenta las funciones del lenguaje AdvPL.

El AdvPL tiene varias funciones preprogramadas extremamente útiles y necesarias para el desarrollo de aplicaciones sofisticadas. Las funciones constituyen el gran poder del AdvPL, considerándose incluso como un recurso más importante que los comandos.

Todas las funciones de la biblioteca estándar del AdvPL tiene la siguiente forma:

FUNCIÓN(<lista de argumentos>)

FUNCIÓN define el nombre que identifica la función y la lista de argumentos, entre paréntesis, son sus argumentos, separados por vírgulas.

Los argumentos de las funciones son valores con los cuales la función ejecutará alguna operación y suministrará un resultado. Los argumentos pueden estar constituidos de cadenas de caracteres, variables, números, valores lógicos, fechas, expresiones válidas de cualquier tipo, arrays, elementos de arrays, bloques de código, objetos, etc.

Algunas funciones tienen solamente un argumento, otras tienen varias y existen algunas funciones que no tienen argumentos, solamente suministran valores o ejecutan determinadas instrucciones.

Así como los comandos, las funciones se presentan por medio de los siguientes tópicos:

Tópico	Contenido
Función	Identifica el nombre de la función
Sintaxis	Define la sintaxis para su utilización
Propósito	Define su propósito principal
Argumentos	Especifica la lista de los argumentos que la función utiliza
Utilización	Describe cómo debe utilizarse la función
Sugerencias	Suministra información útil para la utilización de las funciones
Ejemplo	Presenta algunos ejemplos prácticos de la aplicación de la función
Vea también	Lista otras funciones y comandos relacionados a la función presentada, que también deben consultarse

Notación y convenciones de la sintaxis

Para la presentación y explicación de las funciones del AdvPL, utilizaremos un tipo de notación estandarizada y tradicional. A continuación presentamos las convenciones y símbolos de esta notación:

Las palabras clave reservadas que identifican los nombres de las funciones del AdvPL son siempre escritas en letras mayúsculas, dentro de paréntesis. Por ejemplo: SQRT() – función raíz cuadrada
Los argumentos que debe informar el pelo lector aparecerán entre los signos menor y mayor ( < > ) y estarán en letras minúsculas. Por ejemplo: SQRT(<expresión numérica>)
- Los signos < y > no forman parte de la sintaxis de la función, utilizándose solamente para representar la información que debe suplirse por el lector.
- los argumentos opcionales de algunas funciones se presentan entre corchetes [ ]. Esto significa que el lector podrá o no incluir estos argumentos si utiliza la función, pues estos son opcionales. Con excepción de la declaración de arrays, los corchetes no forman parte de la sintaxis de las funciones, utilizándose solamente para representar la parte que puede informarse opcionalmente por el lector. Por ejemplo:
  - STR(<expresión carácter> [, <expresión numérica 1> ] [, <expresión numérica 2> ])
  - Las opciones alternativas de algunas funciones se indicarán por medio de la barra inclinada ( / ).
  - Los nombres de las funciones definidas por el programador, es decir, funciones no pertenecientes al AdvPL, presentarán la primera letra de su nombre en letra mayúscula y las restantes en letras minúsculas. Por ejemplo: Calcmed().
  - Los nombres de archivos se presentarán en letras mayúsculas. Por ejemplo: MATA020.PRW

Primero presentaremos las funciones en orden alfabético. Sin embargo, al final de la documentación existe un tópico agrupando las funciones por funcionalidad.