Programmer Guide/Command Reference/LIST: Difference between revisions
From STX Wiki
Jump to navigationJump to search
m (1 revision: Initial import) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
<var>var</var> := LIST <var>type</var> [ <var>table</var> [ <var>field</var> [ <var>reset</var> ] ] ] | |||
The <code>LIST</code> command list all items of a | The <code>LIST</code> command returns a list of all shell items of the type named by the <code>type</code> argument. If you supply a table item, <code>table</code>, {{STX}} will use this table for storing the item list. Here, <code>table</code> may be either a simple table or an extended table. | ||
The argument <var>table</var> is the name of a table item where the list result should be stored. Simple tables should be used for lists. If <var>table</var> is an extended table, you can specify which field to store the list in using <var>field</var>. <var>var</var> contains the number of listed items. If no table is specified, the command can be used to count items. | |||
{| | {| | ||
Revision as of 04:10, 22 April 2011
var := LIST type [ table [ field [ reset ] ] ]
The LIST command returns a list of all shell items of the type named by the type argument. If you supply a table item, table, STx will use this table for storing the item list. Here, table may be either a simple table or an extended table.
The argument table is the name of a table item where the list result should be stored. Simple tables should be used for lists. If table is an extended table, you can specify which field to store the list in using field. var contains the number of listed items. If no table is specified, the command can be used to count items.
| type | SPUCODE | SOUNDFILE | CLASS
|
| table | target table item |
| field | target field (if table is an extended table) |
| reset | 1 )
|
