Copy (Stringlist function)

From m204wiki
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 arguments and returns a Stringlist object. If you are new to object-oriented programming or the Janus APIs, you should read "Copying objects".


%outList = sl:Copy

Syntax terms

%outList A Stringlist to contain the copy of the method Stringlist sl.
sl A Stringlist object, which may be Null.

Usage notes

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

See also