Programmer Guide/Command Reference/LIST

The LIST command may be used for retrieving the list of all shell items of a certain type; of for simply counting how many items of a certain type there are.

Retrieving a list of shell items

var := LIST type table [ field [ reset ] ]

The LIST command retrieves a list of all shell items of the type named by the type argument, or of macros, SPUs, or soundfiles (see the table below). It will store this list in the STx table item table. Here, table may be either a simple table or an extended table. In the latter case, by supplying field, you may choose the field where to store the names of the retrieved shell items.

You may use the reset argument for implicitly clearing the table item before retrieving the list of shell items, with 1 causing the table to be cleared, and 0 leaving the current contents of the table unharmed, and appending the retrieved item list to the table.

type	a shell item type, or one of the keywords MACROCODE, SPUCODE, SOUNDFILE, and CLASS
table	target table item
field	target field (if table is an extended table)
reset	clear target table (0 or 1)

Counting shell items

var := LIST type

Without any further arguments, the LIST command simply returns the number of shell items of type type, or of macros, SPUs, or soundfiles (see the table below).

type	a shell item type or MACROCODE, SPUCODE, SOUNDFILE, or CLASS