Terms:
- var or var name - a valid ARexx var name, e.g. var var.0 var.name
- stem or stem name -as var but indicates that some fields of the ARexx compound var may
be set
- object name - the name of an object as a valid ARexx var name; usually an object name
can't be specified as an empty string, unless it is of type O (see below)
Types of arguments:
| Type |
Description |
Rendered in templates as |
Note |
| D |
any data |
|
any char |
| N |
integer |
/N |
ARexx integral number |
| S |
symbol |
/S |
ARexx valid symbol |
| V |
stem name |
/V |
as S but with length<=32 |
| O |
symbol |
/O |
as S but also "" |
Arguments templates form:
- the angular brackets <...> indicate that the argument is required
- the square brackets [...] indicate that the argument is optional
- the brace brackets { ... } indicate that the argument is optional and
may be repeated
The template of the function NewObj() is
<class/V>,[name/O],[stem/V],[freeChild/N]
it means that the arguments of the function are:
- class is required and must be a valid ARexx symbol <32 chars
- name is optional or may be an empty string; if supplied must be a valid ARexx
symbol
- stem is optional; if supplied, must be a valid ARexx symbol <32 chars
- freeChilds is optional; if supplied, must be a valid integral number