Programmer Guide/Command Reference/LIST - Revision history

Jw: /* Counting shell items */

2016-04-14T11:32:30Z

Counting shell items

← Older revision		Revision as of 13:32, 14 April 2016
Line 35:		Line 35:
	<var>var</var> := LIST <var>type</var>		<var>var</var> := LIST <var>type</var>

	Without any further arguments, the <code>LIST</code> command simply returns the number of shell items of type <var>type</var>, or of macros, SPUs, or ~~soundfiles~~ (see the table below).		Without any further arguments, the <code>LIST</code> command simply returns the number of shell items of type <var>type</var>, or of macros, SPUs, or sound files (see the table below).
	{\|		{\|
	\|-		\|-

Jw: /* Retrieving a list of shell items */

2016-02-29T09:49:01Z

Retrieving a list of shell items

← Older revision		Revision as of 11:49, 29 February 2016
Line 24:		Line 24:
	\|clear target table (<code>0</code> or <code>1</code>)		\|clear target table (<code>0</code> or <code>1</code>)
	\|}		\|}

			===Example===
			// display list of loaded macros in current shell
			#tListMacros := new table * /g
			list macrocode $#tListMacros
			showitem $#tListMacros

	== Counting shell items ==		== Counting shell items ==

Christian: /* Retrieving a list of shell items */

2014-04-25T14:53:31Z

Retrieving a list of shell items

← Older revision		Revision as of 16:53, 25 April 2014
Line 6:		Line 6:
	<var>var</var> := LIST <var>type</var> <var>table</var> [ <var>field</var> [ <var>reset</var> ] ]		<var>var</var> := LIST <var>type</var> <var>table</var> [ <var>field</var> [ <var>reset</var> ] ]

	The <code>LIST</code> command retrieves a list of all shell items of the type named by the <code>type</code> argument, or of macros, SPUs, or soundfiles (see the table below). It will store this list in the {{STX}} table item <var>table</var>. Here, <var>table</var> may be either a [[Programmer_Guide/Concepts/Simple_table\|simple table]] or an [[Programmer_Guide/Concepts/Extended_table\|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 retrieves a list of all shell items of the type named by the <code>type</code> argument, or of macros, [[Programmer_Guide/Shell_Items/SPU\|SPUs]], or soundfiles (see the table below). It will store this list in the {{STX}} table item <var>table</var>. Here, <var>table</var> may be either a [[Programmer_Guide/Concepts/Simple_table\|simple table]] or an [[Programmer_Guide/Concepts/Extended_table\|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.		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.

Christian: /* Retrieving a list of shell items */

2011-04-22T03:40:42Z

Retrieving a list of shell items

← Older revision		Revision as of 05:40, 22 April 2011
Line 19:		Line 19:
	\|-		\|-
	\|field		\|field
	\|target field (if table is an extended table)		\|target field (if table is an [[Programmer_Guide/Concepts/Extended_table\|extended table]])
	\|-		\|-
	\|reset		\|reset

Christian: /* Retrieving a list of shell items */

2011-04-22T03:40:02Z

Retrieving a list of shell items

← Older revision		Revision as of 05:40, 22 April 2011
Line 6:		Line 6:
	<var>var</var> := LIST <var>type</var> <var>table</var> [ <var>field</var> [ <var>reset</var> ] ]		<var>var</var> := LIST <var>type</var> <var>table</var> [ <var>field</var> [ <var>reset</var> ] ]

	The <code>LIST</code> command retrieves a list of all shell items of the type named by the <code>type</code> argument, or of macros, SPUs, or soundfiles (see the table below). 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 retrieves a list of all shell items of the type named by the <code>type</code> argument, or of macros, SPUs, or soundfiles (see the table below). It will store this list in the {{STX}} table item <var>table</var>. Here, <var>table</var> may be either a [[Programmer_Guide/Concepts/Simple_table\|simple table]] or an [[Programmer_Guide/Concepts/Extended_table\|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.		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.

Christian: /* Retrieving a list of shell items */

2011-04-22T03:39:02Z

Retrieving a list of shell items

← Older revision		Revision as of 05:39, 22 April 2011
Line 6:		Line 6:
	<var>var</var> := LIST <var>type</var> <var>table</var> [ <var>field</var> [ <var>reset</var> ] ]		<var>var</var> := LIST <var>type</var> <var>table</var> [ <var>field</var> [ <var>reset</var> ] ]

	The <code>LIST</code> command retrieves a list of all shell items of the type named by the <code>type</code> argument, or of macros, SPUs, or soundfiles (see the table below). 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 retrieves a list of all shell items of the type named by the <code>type</code> argument, or of macros, SPUs, or soundfiles (see the table below). 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.		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.

Christian: /* Counting shell items */

2011-04-22T03:25:16Z

Counting shell items

← Older revision		Revision as of 05:25, 22 April 2011
Line 33:		Line 33:
	\|-		\|-
	\|type		\|type
	\|a shell item type or <code>MACROCODE</code>, <code>SPUCODE</code>, <code>SOUNDFILE</code>, or <code>CLASS</code>		\|a shell item type, or one of the keywords <code>MACROCODE</code>, <code>SPUCODE</code>, <code>SOUNDFILE</code>, and <code>CLASS</code>
	\|-		\|-
	\|}		\|}

Christian: /* Retrieving a list of shell items */

2011-04-22T03:24:57Z

Retrieving a list of shell items

← Older revision		Revision as of 05:24, 22 April 2011
Line 13:		Line 13:
	\|-		\|-
	\|type		\|type
	\|a shell item type or <code>MACROCODE</code>, <code>SPUCODE</code>, <code>SOUNDFILE</code>, or <code>CLASS</code>		\|a shell item type, or one of the keywords <code>MACROCODE</code>, <code>SPUCODE</code>, <code>SOUNDFILE</code>, and <code>CLASS</code>
	\|-		\|-
	\|table		\|table
Line 22:		Line 22:
	\|-		\|-
	\|reset		\|reset
	\|clear target table ( <code>0</code> or <code>1</code> )		\|clear target table (<code>0</code> or <code>1</code>)
	\|}		\|}

Christian at 03:23, 22 April 2011

2011-04-22T03:23:37Z

← Older revision		Revision as of 05:23, 22 April 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	The <code>LIST</code> 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.		The <code>LIST</code> 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 ==		== Retrieving a list of shell items ==

Christian at 03:23, 22 April 2011

2011-04-22T03:23:27Z

← Older revision		Revision as of 05:23, 22 April 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}

	The <code>LIST</code> 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.		The <code>LIST</code> 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.