$ListCpy: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
m (misc cleanup) |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Copy $list</span> | <span class="pageSubtitle">Copy $list</span> | ||
<p class="warn"><b>Note: </b> | <p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$ListCpy</var> function is <var>[[Copy (Stringlist function)|Copy]]</var>. </p> | ||
<var>$ListCpy</var> copies an entire [[$lists|$list]], creating a new $list. The input $list can be created by any of the $list creating functions. | |||
The <var>$ListCpy</var> function accepts one argument and returns a numeric result. | The <var>$ListCpy</var> function accepts one argument and returns a numeric result. | ||
==Syntax== | ==Syntax== | ||
| Line 16: | Line 14: | ||
<p> | <p> | ||
<var class="term">%result</var> is set to the identifier of the output $list.</p> | <var class="term">%result</var> is set to the identifier of the output $list.</p> | ||
<p> | |||
The first argument is the identifier of the input $list. This is a required argument. </p> | |||
=== | ===Return codes=== | ||
<p class="code">-3 - No room in CCATEMP | <p class="code">-3 - No room in CCATEMP | ||
-5 - Required argument not specified | -5 - Required argument not specified | ||
| Line 25: | Line 25: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>All invocations of a particular call to <var>$ListCpy</var> will always return the same $list identifier. Each time that call is executed, if the function is successful then any previous $list created by that call is deleted, and a new list is created. | <li>All invocations of a particular call to <var>$ListCpy</var> will always return the same $list identifier. Each time that call is executed, if the function is successful then any previous $list created by that call is deleted, and a new list is created. </li> | ||
<li><var>$ListCpy</var>'s output $list identifier is associated with the same image as the input $list (as associated with $ListImg). | <li><var>$ListCpy</var>'s output $list identifier is associated with the same image as the input $list (as associated with $ListImg). </li> | ||
<li><var>$ListCpy</var> does a page for page copy of the input $list. As such, it is very efficient (more efficient than $List_Copy_Items) but it is also useless for compressing a list that has become sparse as the result of heavy $ | <li><var>$ListCpy</var> does a page for page copy of the input $list. As such, it is very efficient (more efficient than <var>$List_Copy_Items</var>) but it is also useless for compressing a list that has become sparse as the result of heavy <var>$ListIns</var>, <var>$ListRep</var>, <var>$ListAdj</var> and <var>$ListRem</var> activity. <var>$ListRep</var> and <var>$ListAdj</var> will only cause a $list to become sparse if $list items are replaced with larger $list items or increased in size. For list compression, use <var>[[$List_Copy_Items]]</var>. </li> | ||
</ul> | </ul> | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[ | <li>[[Sirius Functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
Latest revision as of 21:23, 6 June 2018
Copy $list
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListCpy function is Copy.
$ListCpy copies an entire $list, creating a new $list. The input $list can be created by any of the $list creating functions.
The $ListCpy function accepts one argument and returns a numeric result.
Syntax
%result = $ListCpy(list_identifier)
%result is set to the identifier of the output $list.
The first argument is the identifier of the input $list. This is a required argument.
Return codes
-3 - No room in CCATEMP -5 - Required argument not specified -6 - $List identifier invalid
Usage notes
- All invocations of a particular call to $ListCpy will always return the same $list identifier. Each time that call is executed, if the function is successful then any previous $list created by that call is deleted, and a new list is created.
- $ListCpy's output $list identifier is associated with the same image as the input $list (as associated with $ListImg).
- $ListCpy does a page for page copy of the input $list. As such, it is very efficient (more efficient than $List_Copy_Items) but it is also useless for compressing a list that has become sparse as the result of heavy $ListIns, $ListRep, $ListAdj and $ListRem activity. $ListRep and $ListAdj will only cause a $list to become sparse if $list items are replaced with larger $list items or increased in size. For list compression, use $List_Copy_Items.