Document Conventions:conv
Examples Foundation
The following table lists examples for the conventions outlined above.
![B:0588]
| Example | Convention/Description |
|---|---|
| DELETE TAG <cTagName,...> | Commands are uppercase in syntax specifications. User input items such as arguments are specified with a prefix indicating the data type supported for the argument. "..." denotes an arbitrary list of optional arguments. In this example, a list of tag names specified as character strings can be passed to the DELETE TAG command. |
| Deleted() --> lDeleted | "()" in a syntax specification denotes the argument list of a function or procedure, the metasymbol following "-->" the return value of a function. This example indicates that the Deleted() function does not recognize any arguments and returns a logical value. |
| SET BELL on | OFF | <lToggle> | The SET BELL command supports two pre-defined options ("on" and "off"). The option "off" is active by default. As an alternative to the pre-defined options, the desired setting can also be specified as a logical expression. The options are mutually exclusive which means that only one of the pre-defined options or a character expression can be used. |
| Inkey( [<nSeconds>] ) --> nInkeyCode | The Inkey() function can be called with an optional numeric parameter. The default value used in case the parameter is omitted is defined in the description of the parameter. Inkey() returns a numeric key code. |
Feedback
If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.