TOTVS Technology

Page tree
Skip to end of metadata
Go to start of metadata

This part of the documentation introduces the AdvPL language commands.


Each command is displayed through of several topics, related in the table below:






Key-word or name that identifies the command.


It defines, in a schematic manner, the way and rules to use the command.


It describes the main purpose of the command.


If defines the meaning and the way to use each command clause or argument.


It displays concepts for the command application and describes as it is used.


It displays interesting tips and suggestions for the command application.


Generic examples, useful for the application understanding and the command use.

See Also

It displays a list of other commands or functions related to the query.



Notation and syntax convention


For AdvPL commands and functions introduction and explanation, a standard and traditional notation type is used. This notation convention and symbols are displayed below:


  • The key-words that identify AdvPL functions and commands are always written in capital letters. For example: BEGIN SEQUENCE.
  • Policies for the compiler are always displayed in capital letters, precede by the symbol # (numeral). For example: #include.
  • The commands part that must be indicated by the reader are displayed between the less and greater signs ( < > ) and is in capital letters. For example: IF <condição>
    • The signs < e > are not part of the command or function syntax, and are only used to represent the information that must be provided by the reader.
    • The functions arguments that must be indicated by the reader are specified in parentheses ( ), separated by commas and are always in capital letters. For example: SQRT(<expressão numérica>).
    • The optional clauses of some optional commands and arguments of some functions are displayed between square brackets [  ]. It means the reader might add this command or function part it is optional. Excepting the arrays declarations, the square brackets are not part of the commands or functions syntax. They are only used to represent the part that can be optionally indicated by the reader.
    • A code block or matrix is represented in curly brackets { }. For example:
      • { | x | x + 1 }
      • aMat := { 1, 2, 3 }
      • The arguments list used in code blocks must be specified between vertical slashes.
      • The commas are used to separate multiple clauses or arguments in the functions or commands syntax.
      • The symbol ( @ ) at indicates that an arguments must be passed by reference to a function.
      • The alternate options of some functions are indicated through the forward slash ( / ).
      • Repetitive or extensive clauses are indicated by suspension points ( ... ). For example: IF ... ELSEIF ... ELSEIF ... ELSE ... ENDIF.
      • The routines name defined by the programmer, that is, functions that do not belong to AdvPL have the first letter of its name displayed in capital letter and the remained ones are displayed in lower case letters. For example: Calcmed().
      • Obsolete commands or functions are displayed with an asterisk after the name. For example: RECCOUNT()*.
      • The file names are displayed in capital letters. For example: MATA020.PRW.
      • File name extensions start with a point and are written in capital letters. For example: .PRW.


First, the commands are displayed in alphabetic order. But, a topic grouping the commands by functionality are at the end of the documentation.

  • No labels