$ListSavL: Difference between revisions
(Automatically generated page update) |
m (→Syntax) |
||
Line 17: | Line 17: | ||
<p>%result is a either zero, indicating success, or a negative error code.</p> | <p>%result is a either zero, indicating success, or a negative error code.</p> | ||
<p class="code"> | ===Return codes=== | ||
<p class="code">-3 - Not enough room to store list of counts and names | |||
-5 - Required argument not specified | |||
-6 - Invalid $list identifier | |||
</p> | </p> | ||
==Example== | |||
The following procedure uses <var>$ListSav</var> to save information in various lists, and uses <var>$ListSavL</var> and <var>$ListRst</var> to display the saved lists: | The following procedure uses <var>$ListSav</var> to save information in various lists, and uses <var>$ListSavL</var> and <var>$ListRst</var> to display the saved lists: | ||
<p class="code"> B | <p class="code">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 | |||
</p> | </p> | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== |
Revision as of 23:29, 18 July 2013
Count and names of available global $lists
Note: 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.
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
[%RESULT =] $ListSavL(list_identifier)
%result is a either zero, indicating success, or a negative error code.
Return codes
-3 - Not enough room to store list of counts and names -5 - Required argument not specified -6 - Invalid $list identifier
Example
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
Products authorizing $ListSavL
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility