$ListCpy: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Copy $list</span> | <span class="pageSubtitle">Copy $list</span> | ||
<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListCpy function is | <p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListCpy function is <var>[[Copy (Stringlist function)|Copy]]</var>.</p> | ||
This function copies an entire $list, creating a new $list. The input $list can be created by any of the $list creating functions. | This function copies an entire $list, creating a new $list. The input $list can be created by any of the $list creating functions. | ||
| Line 9: | Line 9: | ||
The first argument is the identifier of the input $list. This is a required argument. | The first argument is the identifier of the input $list. This is a required argument. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%result</span> = <span class="literal">$ListCpy</span>(<span class="term">list_identifier</span>) | <p class="syntax"><span class="term">%result</span> = <span class="literal">$ListCpy</span>(<span class="term">list_identifier</span>) | ||
| Line 16: | Line 17: | ||
<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> | ||
===Error 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 | ||
-6 - $List identifier invalid | -6 - $List identifier invalid | ||
</p> | </p> | ||
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. | ==Usage notes== | ||
<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. | |||
<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). | ||
<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 $LISTINS, $LISTREP, <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>.<p> | <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 $LISTINS, $LISTREP, <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>.<p> | ||
</ul> | |||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
| Line 41: | Line 44: | ||
</ul> | </ul> | ||
[[Category:$Functions|$ListCpy]] | [[Category:$Functions|$ListCpy]] | ||
Revision as of 21:50, 18 July 2013
Copy $list
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListCpy function is Copy.
This function 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.
The first argument is the identifier of the input $list. This is a required argument.
Syntax
%result = $ListCpy(list_identifier)
%result is set to the identifier of the output $list.
Error 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.