Programmer Guide/Command Reference/LIST: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
Line 14: Line 14:


Without any further arguments, the <code>LIST</code> command simply returns the number of shell items of type <var>type</var>.
Without any further arguments, the <code>LIST</code> command simply returns the number of shell items of type <var>type</var>.
{|
|-
|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> )
|}

Revision as of 05:17, 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.

Counting shell items

var := LIST type

Without any further arguments, the LIST command simply returns the number of shell items of type type.

Navigation menu

Personal tools