Function argument syntax

Arguments typically have some restrictions on the expression used for that argument. For example, the input argument to the INDEX function can only be an object name. Depending on the function, one or many data objects can be used for an input argument for one function evaluation.

For each function listed in this documentation, the input argument has a syntax definition that indicates:

  • the number of objects that can be used for each argument for one function evaluation, expressed as either single or series

followed by

  • the type of expression that can be used for each argument.

For the output argument, the syntax specification is similar to the input argument syntax, except that the output is always used as a specific type of object, not an expression.

For example, single-item-expression means one evaluation operates on a single item that can be defined as an item expression. Series-item-expression means one evaluation operates on one or more input argument items that can be defined as an item expression.

In this documentation, the terms listed in the following table are used to describe the syntax of function arguments.

Any valid combination of object names, literals, operators, function names, and map names.
Any valid combinations of object names, literals, conditional operators, and functions whose output arguments are specified as true or false.
Any valid combination of object names, literals, operators, and functions whose output argument is specified as an item.

If an item must be interpreted as a date, time, or number, the item is referenced by its interpretation. For example, if an item-expression must be text, it is specified as text-expression.

An object name or a series producing function.

If an object expression is further limited to be an item, it is specified as item-object-expression.

The name of a data object, as defined in Data Object Names. If an object name is further limited, it is specified as a prefix. For example, simple-object-name refers to a simple type name.
Indicates that the function can take on any number of additional similar arguments.
[ ]
Indicates that the argument is optional.
{ literal , literal ...}
An enumerated series of literals.

The syntax specification shows each input argument, using terms as described in the previous table, preceded by the word single or series. For example:

ALL ( series-condition-expression )

The arguments are defined using a name that describes its use by the function. A simple example is:

DATETONUMBER ( date_to_convert )

Function names are shown in uppercase letters in this documentation. However, function names are not case sensitive.

There is also a description of what each function returns.

A single integer