Caché ObjectScript Reference - InterSystems Documentation

Caché ObjectScript CommandsThis document provides detailed descriptions of the commands supported by CachéObjectScript. In this manual, Caché ObjectScript commands are divided into three groups:• General Commands.• Routine and Debugging Commands (the names of which begin with “Z”).• Legacy (obsolete) Commands.Within each group, the commands are presented in alphabetical order.For more information on ObjectScript commands generally, see the Commands chapter ofUsing Caché ObjectScript.You can abbreviate most commands to the first letter of the command name, or, in the caseof commands that begin with the letter Z, to the first two letters of the command name. Inthe Synopsis for each command, the full name syntax is first presented, and below it is shownthe abbreviated name (if one exists).The Synopsis for each command contains only literal syntactical punctuation. The Synopsisdoes not include punctuation for format conventions, such as what elements of the syntax areoptional. This information is provided in the table of arguments immediately following theSynopsis.The one exception is the ellipsis (...). An ellipsis following a comma indicates that the argument(or argument group) preceding the comma can be repeated multiple times as a comma-separatedlist. An ellipsis within curly braces { . . . } indicates that a block of code containing oneor more commands can be specified within the curly braces. The curly braces are literalcharacters that must be specified in the code.Most commands take one or more arguments. Arguments are expressions (for example, afunction and its parameters, a variable, an operator and its operands, an object property, oran object method) that define or control the action of the command. Multiple arguments usedwith a command are generally referred to as an argument list. Some commands have argumentsthat themselves take argument parameters. For example, each argument of the DO commandcan take a parameter list. This is indicated in the syntax.Some commands are argumentless, and can be invoked without any arguments. Some commandsnever take arguments; other commands take arguments only in certain circumstances.Caché ObjectScript Reference 15