Syntax conventions

Official Content
This documentation is valid for:

This document describes the typographic conventions used in the GeneXus Help documentation.

Syntax is the order and the way in which you must type a command-line command or utility name, and any arguments and options that follow it. The elements in bold indicate that you must type them in the syntax line exactly as they appear; the elements in italics are placeholders representing information that you must supply.

Since GeneXus is not case-sensitive, you can use uppercase, lowercase or a mix of both when introducing commands, rules, etc. However, string comparisons are always case-sensitive, and databases may also be case-sensitive too.

Syntax line using the standard conventions:

Sample {r | s} arguments … [options]

The meaning of each of these elements is as follows:

Example Meaning
Sample Specifies the name of the command or utility. Words and symbols that you are instructed to type appear in bold.
{   } Indicates a set of choices available for you to select one.
'{'  '}' In those cases where the language itself contains the {} symbol, to distinguish them, the symbol in the language is in bold and between simple quotation marks. 
| Separates two or more mutually exclusive elements in a syntax line. You have to enter one of these choices, not the symbol.
<Arguments> Indicates a variable name or other information that you must provide, such as a path and file name. Letters in italics indicate placeholders for information you supply.
Indicates that the elements to the left can be repeated several times in a command line. You only have to type the information, not the ellipsis (…).
[ ] Indicates optional items. You only have to type the information within the brackets, not the brackets.
&variable In syntax, variable names are preceded by the ‘&’ symbol.

 

Notes

Uses of “{}” braces include:

  • They are added to indicate that you must type an attribute or variable name. For ex: {attribute | &variable}.
  • They may not appear when it’s clear from the context which syntax expressions the “|” is applied to.
  • They may appear even though there aren’t several options inside them to indicate that the suspension points apply to all the elements between brackets. For ex: {Where condition}... 
  • If all the options inside the braces are in square brackets, you may choose not to type anything there.

Examples

Here are syntax lines for a GeneXus command and some possible uses:

Syntax of a Confirm Command

Confirm( {'msg' | &var} [, {Y | N}])

Where:
msg
     Text to be displayed.

var
     Variable name whose type is character. Contains text to be displayed.

You can type:

  • Confirm('Confirm Supplier deletion?’, N)
  • Confirm('Confirm Supplier deletion?’)
  • Confirm(&confMsg, Y)