$ListCpy: Difference between revisions
m (1 revision) |
m (1 revision) |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Copy $list</span> | <span class="pageSubtitle">Copy $list</span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListCpy function is the [[Copy (Stringlist function)]].</p> | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$ListCpy</var> function is the [[Copy (Stringlist function)]].</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. | ||
The $ListCpy function accepts one argument and returns a numeric result. | The <var>$ListCpy</var> function accepts one argument and returns a numeric result. | ||
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. | ||
| Line 24: | Line 24: | ||
</p> | </p> | ||
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. | 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. | ||
$LISTCPY's output $list identifier is associated with the same image as the input $list (as associated with $ListImg). | $LISTCPY'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, $ListAdj and <var>$ListRem</var> activity. <var>$ListRep</var> 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 <var>[[$List_Copy_Items]]</var>.<p> | <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 class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
Revision as of 19:25, 19 October 2012
Copy $list
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $ListCpy function is the Copy (Stringlist function).
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
<section begin="syntax" /> %RESULT = $ListCpy(list_identifier) <section end="syntax" />
$ListCpy Function
%RESULT is set to the identifier of the output $list.
-3 - No room in CCATEMP -5 - Required argument not specified -6 - $List identifier invalid
$ListCpy Error Codes
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.
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility
Products authorizing $ListCpy