$ListSavL: Difference between revisions
mNo edit summary |
mNo edit summary |
||
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="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListSavL function is [[to be entered]].</p> | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$ListSavL</var> function is [[to be entered]].</p> | ||
This function retrieves the count of items in, and names of, the $lists that have been saved by either the $List_Global, $ListSav, or $ListSave function and not, in the current request, restored by $ListRst. | This function retrieves the count of items in, and names of, the $lists that have been saved by either the $List_Global, $ListSav, or <var>$ListSave</var> function and not, in the current request, restored by $ListRst. | ||
The $ListSavL function accepts one argument and returns a numeric error code. It is a callable $function (see [[Calling Sirius Mods $functions]]). | The <var>$ListSavL</var> function accepts one argument and returns a numeric error code. It is a callable $function (see [[Calling Sirius Mods $functions]]). | ||
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 $ListRst in the current <var class="product">User Language</var> request. | 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 $ListRst in the current <var class="product">User Language</var> request. | ||
Line 25: | Line 25: | ||
</p> | </p> | ||
The following procedure uses $ListSav to save information in various lists, and uses $ListSavL and $ListRst to display the saved lists: | The following procedure uses <var>$ListSav</var> to save information in various lists, and uses <var>$ListSavL</var> and $ListRst to display the saved lists: | ||
<p class="code"> B | <p class="code"> B | ||
... | ... |
Revision as of 19:04, 19 October 2012
Count and names of available global $lists
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListSavL function is to be entered.
This function retrieves the count of items in, and names of, the $lists that have been saved by either the $List_Global, $ListSav, or $ListSave function and not, in the current request, restored by $ListRst.
The $ListSavL function accepts one argument and returns a numeric error code. It is a callable $function (see Calling Sirius Mods $functions).
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 $ListRst in the current User Language request.
Syntax
<section begin="syntax" /> [%RESULT =] $ListSavL(list_identifier) <section end="syntax" />
-3 - Not enough room to store list of counts and names -5 - Required argument not specified -6 - Invalid $list identifier
The following procedure uses $ListSav to save information in various lists, and uses $ListSavL and $ListRst to display the saved lists:
B ... %RESULT = $ListSav(%LIST, 'name') ... END CLOSE ALL B %SAVED = $ListNew %RESULT = $ListSavL(%SAVED) FOR %I FROM 1 TO $ListCnt(%SAVED) %N = $ListInf(%SAVED, %I, 1, 10) %NAME = $ListInf(%SAVED, %I, 12) PRINT %N ' items in ' %NAME ':' %LIST = $ListRst(%NAME) FOR %J FROM 1 TO %N PRINT $ListInf(%LIST, %J) END FOR END FOR END