Copy (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 8: Line 8:
{{Template:Stringlist:Copy syntax}}
{{Template:Stringlist:Copy syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt>%outlist<dd>A Stringlist to contain the copy of the method Stringlist '''%sl'''<dt>%sl<dd>A Stringlist object.  
<tr><th>%outlist</th>
</dl>
<td>A Stringlist to contain the copy of the method Stringlist '''%sl'''</td></tr>
<tr><th>sl</th>
<td>A Stringlist object.</td></tr>
</table>


==Usage notes==
==Usage notes==

Revision as of 21:02, 16 January 2011

Copy Stringlist (Stringlist class)


This method copies an entire Stringlist, creating a new Stringlist. The Copy method accepts no argument and returns a Stringlist object. If you are new to object-oriented programming or the Janus APIs you should read about Copying objects.

Copy is a member of the Stringlist class.

Syntax

%outList = sl:Copy

Syntax terms

%outlist A Stringlist to contain the copy of the method Stringlist %sl
sl A Stringlist object.

Usage notes

  • All errors in Copy result in request cancellation.
  • If the method Stringlist was associated with an image, by either the BindImage or New method, the output Stringlist is associated with the same image, as if a BindImage method had been invoked on the result of the Copy method.
  • Copy does a page-for-page copy of the input Stringlist. As such, it is very efficient (more efficient than CopyItems), but it is also useless for compressing a Stringlist that has become sparse as the result of heavy Insert, Replace, ChangeItemLength, and RemoveItem activity. Replace and ChangeItemLength cause a Stringlist to become sparse only if Stringlist items are replaced with larger Stringlist items or increased in size. For list compression, use CopyItems (Stringlist function).