Exibir origem

Esta parte da documentação apresenta as funções da linguagem AdvPL.

O AdvPL possui várias funções pré-programadas extremamente úteis e necessárias ao desenvolvimento de aplicações sofisticadas. As funções constituem o grande poder do AdvPL, sendo consideradas até como um recurso mais importante do que os comandos.

Todas as funções da biblioteca padrão do AdvPL possuem a seguinte forma:

FUNÇÃO(<lista de argumentos>)

FUNÇÃO define o nome que identifica a função e a lista de argumentos, entre parênteses, são os seus argumentos, separados por vírgulas.

Os argumentos das funções são valores com os quais a função executará alguma operação e fornecerá um resultado. Os argumentos podem ser constituídos por cadeias de caracteres, variáveis, números, valores lógicos, datas, expressões válidas de qualquer tipo, arrays, elementos de arrays, blocos de código, objetos, etc.

Algumas funções possuem apenas um argumento, outras possuem várias e existem algumas funções que não possuem argumentos, apenas fornecem valores ou executam determinadas instruções.

Assim como os comandos, as funções são apresentadas através dos seguintes tópicos:

Tópico	Conteúdo
Função	Identifica o nome da função
Sintaxe	Define a sintaxe para a sua utilização
Propósito	Define o seu propósito principal
Argumentos	Especifica a lista dos argumentos que a função utiliza
Utilização	Descreve como a função deve ser utilizada
Dicas	Fornece informações úteis para a utilização das funções
Exemplo	Apresenta alguns exemplos práticos da aplicação da função
Veja também	Lista outras funções e comandos relacionados à função apresentada, que também devem ser consultados

Notação e convenções de sintaxe

Para a apresentação e explicação das funções do AdvPL, usaremos um tipo de notação padronizada e tradicional. Apresentamos abaixo as convenções e símbolos desta notação:

As palavras-chave reservadas que identificam os nomes das funções do AdvPL são sempre escritas em letras maiúsculas, acompanhadas de um abre e fecha parênteses. Por exemplo: SQRT() – função raiz quadrada
Os argumentos que deverão ser informados pelo leitor aparecerão entre os sinais menor e maior ( < > ) e estarão em letras minúsculas. Por exemplo: SQRT(<expressão numérica>)
- Os sinais < e > não fazem parte da sintaxe da função, sendo utilizados apenas para representar a informação que deve ser suprida pelo leitor.
Os argumentos opcionais de algumas funções são apresentados entre colchetes [ ]. Isto significa que o leitor poderá ou não incluir estes argumentos quando utilizar a função, pois eles são opcionais. Com exceção da declaração de arrays, os colchetes não fazem parte da sintaxe das funções, sendo utilizados apenas para representar a parte que pode ser opcionalmente informada pelo leitor. Por exemplo:
- STR(<expressão caracter> [, <expressão numérica 1> ] [, <expressão numérica 2> ])
As opções alternativas de algumas funções serão indicadas através da barra inclinada ( / ).
Os nomes das funções definidas pelo programador, ou seja, funções não pertencentes ao AdvPL, terão a primeira letra do seu nome apresentada em letra maiúscula e as restantes em letras minúsculas. Por exemplo: Calcmed().
Os nomes de arquivos serão apresentados em letras maiúsculas. Por exemplo: MATA020.PRW

Primeiro apresentaremos as funções em ordem alfabética. Porém, no final da documentação existe um tópico agrupando as funções por funcionalidade.