Copy (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (→Syntax terms) |
||
Line 9: | Line 9: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%outList</th> | <tr><th>%outList</th> | ||
<td>A <var>Stringlist</var> to contain the copy of the method <var>Stringlist</var> <var class="term">sl</var></td></tr> | <td>A <var>Stringlist</var> to contain the copy of the method <var>Stringlist</var> <var class="term">sl</var>.</td></tr> | ||
<tr><th>sl</th> | <tr><th>sl</th> |
Latest revision as of 15:16, 31 October 2012
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".
Syntax
%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.