Programmer Guide/Command Reference/LIST: Difference between revisions
| Line 8: | Line 8: | ||
The <code>LIST</code> command retrievs a list of all shell items of the type named by the <code>type</code> argument. It will store this list in the {{STX}} table item <var>table</var>. Here, <var>table</var> may be either a simple table or an extended table. In the latter case, by supplying <var>field</var>, you may choose the field where to store the names of the retrieved shell items. | The <code>LIST</code> command retrievs a list of all shell items of the type named by the <code>type</code> argument. It will store this list in the {{STX}} table item <var>table</var>. Here, <var>table</var> may be either a simple table or an extended table. In the latter case, by supplying <var>field</var>, you may choose the field where to store the names of the retrieved shell items. | ||
You may use the <var>reset</var> argument for implicitly clearing the table item before retrieving the list of shell items, with <code>1</code> causing the table to be cleared, and <code>0</code> leaving the current contents of the table unharmed, and ''appending'' the retrieved item list to the table. | |||
{| | |||
|- | |||
|type | |||
|a shell item type or <code>MACROCODE</code> | <code>SPUCODE</code> | <code>SOUNDFILE</code> | <code>CLASS</code> | |||
|- | |||
|table | |||
|target table item | |||
|- | |||
|field | |||
|target field (if table is an extended table) | |||
|- | |||
|reset | |||
|clear target table ( <code>0</code> | <code>1</code> ) | |||
|} | |||
== Counting shell items == | == Counting shell items == | ||
Revision as of 05:20, 22 April 2011
The LIST 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 retrievs a list of all shell items of the type named by the type argument. 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 | SPUCODE | SOUNDFILE | CLASS
|
| table | target table item |
| field | target field (if table is an extended table) |
| reset | 1 )
|
Counting shell items
var := LIST type
Without any further arguments, the LIST command simply returns the number of shell items of type type.
