You can use functions in formulas to perform additional tasks. Most functions require a set of input arguments, but all functions evaluate to a single variant value. All functions share the following general syntax:
FUNCTIONNAME(arg1,arg2,...argN)
where the following rules apply:
- FUNCTIONNAME - must be a valid function name
- () - the function name must be followed by an open and close parentheses, even if the function takes no arguments.
- , - the comma is the only allowed delimiter, which can be used to separate the function arguments.
Some arguments of a function may be optional. These arguments are enclosed in square brackets ("[" and "]").
Certain functions would expect specific arguments to be of a certain type, or convertible to that type. In the documentation we use a simple prefix before each argument to denote the variant type that the function will internally convert the variant to. Following is a list of the used prefixes:
Prefix | Description |
---|---|
var | Any variant. The documentation states if there are other limitations. |
b | Variant convertible to boolean |
n | Variant convertible to number |
m | Variant convertible to measure |
nm | Variant convertible to number or measure. |
s | Variant convertible to string |
dt | Variant convertible to data time |
arr | Variant array |
The currently available functions are logically grouped in the following categories:
Depending on whether a function supports chaining or aggregation, functions can be further classified as Chain_Functions or Aggregate_Functions.