Using Caché ObjectScript - InterSystems Documentation

7
Functions
Functions are pieces of code which perform common tasks. Functions may either return a value or execute silently without
returning a value. Caché supplies dozens of functions, which can perform mathematical operations, manipulation of strings
and time values, and perform other actions.
System-supplied functions (sometimes known as “intrinsic” functions), which you cannot modify, are identifiable as they
always begin with a single dollar sign (“$”); the Caché ObjectScript Language Reference describes each of the systemsupplied
functions. In addition to its system-supplied functions, ObjectScript also supports user-defined code (sometimes
known as “extrinsic” code).
7.1 Function Syntax
To invoke a system-supplied function, use the form:
$name(parameters)
where
Table 7–1: Invoking Caché ObjectScript Functions
name
parameters
The name of the function. The preceding dollar sign ($) is required. Function names
are not case-sensitive, whether system-supplied or user-defined (method names
are not). Many system function names have abbreviations; each of these is listed in
the reference page for the function itself.
One or more values to be passed to the function. The parentheses are mandatory,
even if the function has no parameters. The parameters are positional and must
match the order of the parameters expected by the function. Multiple parameters
are separated from each other by commas. Spaces are permitted anywhere in the
parameter list. No spaces are permitted between name and the open parenthesis
character.
Function parameters represent specific values that you supply. All defined parameters are shown in each syntax section.
Some of these parameters are required and some are optional. Optional arguments and parameters are indicated as such in
the Parameters section of each reference page.
Also shown in many syntax sections are required punctuation characters used with some parameters. These include parentheses,
commas, curly braces, colons, equal signs, and plus and minus signs.
Using Caché ObjectScript 73