Esta parte da documentação apresenta os comandos da linguagem AdvPL.

 

Cada comando será apresentado através de diversos tópicos, relacionados na tabela abaixo.

 

 

Tópico

Conteúdo

Comando

Palavra-chave ou nome que identifica o   comando.

Sintaxe

Define, de maneira esquemática, a forma e   as regras para a utilização do comando.

Propósito

Descreve o objetivo principal ou propósito   do comando.

Argumentos

Define o significado e a forma de utilizar   cada cláusula ou argumento do comando.

Utilização

Apresenta conceitos para a aplicação do   comando e descreve como utilizá-lo.

Dicas

Apresenta dicas e sugestões interessantes   para a aplicação do comando.

Exemplo

Exemplos genéricos, úteis para o   entendimento da aplicação e utilização do comando.

Veja também

Apresenta uma lista de outros comandos ou   funções relacionados para consulta.

 

 

Notação e convenções de sintaxe

 

Para a apresentação e explicação dos comandos e 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 que identificam os comandos e funções do AdvPL são sempre escritas em letras maiúsculas. Por exemplo: BEGIN SEQUENCE
  • Diretivas para o compilador são sempre apresentadas em letras minúsculas, precedidas pelo símbolo # (numeral). Por exemplo: #include
  • A parte dos comandos que deverá ser informada pelo leitor aparecerá entre os sinais menor e maior ( < > ) e estará em letras minúsculas. Por exemplo: IF <condição>
    • Os sinais < e > não fazem parte da sintaxe do comando ou função, sendo utilizados apenas para representar a informação que deve ser suprida pelo leitor.
  • Os argumentos das funções que devem ser informados pelo leitor são especificados entre parênteses ( ), separados por vírgulas e sempre estarão em letras minúsculas. Por exemplo: SQRT(<expressão numérica>)
  • As cláusulas opcionais de alguns comandos ou argumentos opcionais de algumas funções são apresentados entre colchetes [  ]. Isto significa que o leitor poderá ou não incluir esta parte do comando ou função, pois ela é opcional. Com exceção da declaração de arrays, os colchetes não fazem parte da sintaxe dos comandos ou funções, sendo utilizados apenas para representar a parte que pode ser opcionalmente informada pelo leitor.
  • Um bloco de código ou matriz são representados entre chaves { }. Por exemplo:
    • { | x | x + 1 }
    • aMat := { 1, 2, 3 }
  • A lista de argumentos utilizados em blocos de código deve ser especificada entre barras verticais |  |.
  • A vírgula será utilizada para separar múltiplas cláusulas ou argumentos contidos na sintaxe de comandos ou funções.
  • O símbolo arroba ( @ ) indicará que um argumento deve ser passado por referência para uma função.
  • As opções alternativas de alguns comandos serão indicadas através da barra inclinada ( / ).
  • Cláusulas repetitivas ou extensas serão indicadas por reticências ( ... ). Por exemplo: IF ... ELSEIF ... ELSEIF ... ELSE ... ENDIF.
  • Os nomes das rotinas 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().
  • Comandos ou funções obsoletos serão apresentados com um asterisco após o seu nome. Por exemplo: RECCOUNT()*
  • Os nomes de arquivos serão apresentados em letras maiúsculas. Por exemplo: MATA020.PRW
  • Extensões de nomes de arquivos serão iniciadas por um ponto e escritas em letras maiúsculas. Por exemplo: .PRW

 

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

  • Sem rótulos