$ListSavL - Revision history

JAL: minor wordsmithing

2016-04-11T18:28:33Z

minor wordsmithing

← Older revision		Revision as of 18:28, 11 April 2016
Line 26:		Line 26:

	===Return codes===		===Return codes===
	<p class="code">>=0 – Number of $lists found ~~to satisfy the criteria~~		<p class="code">>=0 – Number of suitable saved $lists found
	-3 – Not enough room to store list of counts and names		-3 – Not enough room to store list of counts and names
	-5 – Required argument not specified		-5 – Required argument not specified

JAL: minor word chnge

2016-04-11T16:36:26Z

minor word chnge

← Older revision		Revision as of 16:36, 11 April 2016
Line 2:		Line 2:
	<span class="pageSubtitle">Count and names of available global $lists</span>		<span class="pageSubtitle">Count and names of available global $lists</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListSavL function is the [[PersistentObjectInfo class]] which returns information about [[Global and session objects\|global and session objects]] allocated to a thread.</p>		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListSavL function is the [[PersistentObjectInfo class]] which returns information about [[Global and session objects\|global and session objects]] allocated to a thread.</p>

	This [[Calling Sirius Mods $functions\|callable]] function retrieves the count of items in, and names of, the [[$lists]] for which both of these are true:		This [[Calling Sirius Mods $functions\|callable]] function retrieves the count of items in, and names of, the [[$lists]] for which both of these are true:
Line 26:		Line 26:

	===Return codes===		===Return codes===
	<p class="code">>=0 – ~~Count~~ of ~~saved~~ $lists		<p class="code">>=0 – Number of $lists found to satisfy the criteria
	-3 – Not enough room to store list of counts and names		-3 – Not enough room to store list of counts and names
	-5 – Required argument not specified		-5 – Required argument not specified

JAL: misc cleanup

2016-04-11T16:25:43Z

misc cleanup

← Older revision		Revision as of 16:25, 11 April 2016
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListSavL function is the [[PersistentObjectInfo class]] which returns information about [[Global and session objects\|global and session objects]] allocated to a thread.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListSavL function is the [[PersistentObjectInfo class]] which returns information about [[Global and session objects\|global and session objects]] allocated to a thread.</p>

	This function retrieves the count of items in, and names of, the [[$lists]] ~~that have been saved~~ by ~~either~~ the <var>$List_Global</var>, <var>$ListSav</var>, or <var>$ListSave</var> function ~~and not, in the current request, restored by <var>$ListRst~~</~~var~~>.		This [[Calling Sirius Mods $functions\|callable]] function retrieves the count of items in, and names of, the [[$lists]] for which both of these are true:
			<ul>
			<li>Saved by the <var>$List_Global</var>, <var>$ListSav</var>, or <var>$ListSave</var> function </li>

	~~The~~ <var>$~~ListSavL~~</var> ~~function accepts one argument and returns a numeric error code. It is a [[Calling Sirius Mods $functions\|callable]] $function.~~		<li>Not, in the current request, restored by <var>$ListRst</var> </li>
			</ul>

	The first argument is the identifier of the $list that is to receive the results. The current contents of the $list are deleted and replaced with the item count and names of available saved $lists. Each $list item contains the 10-digit number of items, followed by a blank, followed by the name of a global $list not yet restored by <var>$~~ListRst~~</var> ~~in the current <var class="product">User Language</var> request~~.		The <var>$ListSavL</var> function accepts one argument and returns a numeric error code.

	==Syntax==		==Syntax==
Line 14:		Line 17:
	</p>		</p>

	<p><var class="term">%result</var> is ~~a either~~ a non-negative number indicating the number of saved $lists or a negative error code.</p>		<ul>
			<li><var class="term">%result</var> is a non-negative number indicating the number of saved $lists, or it is a negative error code.</li>

			<li><var class="term">list_identifier</var> is the identifier of the $list that is to receive the results. The current contents of the $list are deleted and replaced with the item count and names of available saved $lists.
			<p>
			Each $list item contains the 10-digit number of items, followed by a blank, followed by the name of a global $list not yet restored by <var>$ListRst</var> in the current <var class="product">SOUL</var> request. </p></li>
			</ul>

	===Return codes===		===Return codes===
	<p class="code">-3 - Not enough room to store list of counts and names		<p class="code">>=0 – Count of saved $lists
	-5 - Required argument not specified		-3 – Not enough room to store list of counts and names
	-6 - Invalid $list identifier		-5 – Required argument not specified
			-6 – Invalid $list identifier
	</p>		</p>

Alex: /* Syntax */

2016-04-11T05:35:58Z

Syntax

← Older revision		Revision as of 05:35, 11 April 2016
Line 14:		Line 14:
	</p>		</p>

	<p><var class="term">%result</var> is a either ~~zero,~~ indicating ~~success,~~ or a negative error code.</p>		<p><var class="term">%result</var> is a either a non-negative number indicating the number of saved $lists or a negative error code.</p>

	===Return codes===		===Return codes===

JALWiccan: Automatically generated page update

2015-02-19T23:09:29Z