Caché ObjectScript Reference - InterSystems Documentation

Caché ObjectScript FunctionsnameparametersThe name of the function. The preceding dollar sign ($) is required.Function names are shown here in all uppercase letters, but theyare, in fact, case-insensitive. You can abbreviate most functionnames. In the Synopsis for each function, the full name syntax isfirst presented, and below it is shown the abbreviated name (if oneexists).One or more values to be passed to the function. Function arguments,or parameters, are always enclosed in parentheses and follow thefunction name. The parentheses are mandatory, even if the functionhas no parameters.Multiple parameters are separated from each other by commas.Theparameters are positional and must match the order of the parametersexpected by the function. Missing parameters in this sequencecan be indicated by supplying the appropriate number of commas;no trailing commas are required for parameters missing from theend of the parameter list.Spaces are permitted anywhere in the parameter list. No spaces arepermitted between name and the open parenthesis character.The Synopsis for each function contains only literal syntactical punctuation. The Synopsisdoes not include punctuation for format conventions, such as what parameters of the syntaxare optional. This information is provided in the table of parameters immediately followingthe Synopsis.The one exception is the ellipsis (...). An ellipsis following a comma indicates that theparameter (or parameter group) preceding the comma can be repeated multiple times as acomma-separated list.Any platform-specific function is marked with the name of the platform that supports it. Anyfunction that is not marked with a platform abbreviation is supported by all Caché platforms.178 Caché ObjectScript Reference