Copy (Stringlist function)

From m204wiki
Revision as of 16:12, 19 January 2011 by Wiccan (talk | contribs) (1 revision)
Jump to navigation Jump to search

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.

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).