MoveToId (Stringlist subroutine): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (more consistent layout and better tagging) |
||
| Line 9: | Line 9: | ||
<tr><th>sl</th> | <tr><th>sl</th> | ||
<td>A <var>Stringlist</var> object.</td></tr> | <td>A <var>Stringlist</var> object.</td></tr> | ||
<tr><th> | <tr><th>listId</th> | ||
<td>The <var>$list</var> identifier of the <var>$list</var> to which data is to be moved.</td></tr> | <td>The <var>$list</var> identifier of the <var>$list</var> to which data is to be moved.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>All errors in <var>MoveToId</var> result in request cancellation.<li>After <var>MoveToId</var> is invoked, the method <var>Stringlist</var> is emptied, although the object variable is still valid (non-null).<li><var>MoveToId</var> discards | <ul><li>All errors in <var>MoveToId</var> result in request cancellation. | ||
<li>After <var>MoveToId</var> is invoked, the method <var>Stringlist</var> is emptied, although the object variable is still valid (non-null). | |||
<li><var>MoveToId</var> discards any current contents of the target <var>$list</var>. | |||
<li><var>MoveToId</var> copies to the target <var>$list</var> any image association that is set via <var>[[BindImage (Stringlist subroutine)|BindImage]]</var>. | |||
<li><var>MoveToId</var> simply moves the <var>Stringlist</var> internal data pointers to the to the target <var>$list</var>. It does <b><i>not</i></b> actually perform any data movement; therefore, it is extremely efficient.<li><var>MoveToId</var> is intended to facilitate the migration to the use of <var>Stringlists</var> of existing applications that use <var>$lists</var>.<li><var>stringlists</var> should always be used in preference to <var>$lists</var>, so <var>MoveToId</var> is provided only for the migration of existing <var>$list</var> applications to the use of <var>stringlists</var>.</ul> | |||
==Examples== | ==Examples== | ||
Suppose complex subroutine Summarize takes a $list identifier as its input parameter. Now, suppose some code that has a <var>Stringlist</var> in %list wants to pass the <var>Stringlist</var> to Summarize. | <ol><li>Suppose complex subroutine Summarize takes a $list identifier as its input parameter. Now, suppose some code that has a <var>Stringlist</var> in %list wants to pass the <var>Stringlist</var> to Summarize. | ||
The following code illustrates how this can be accomplished: | The following code illustrates how this can be accomplished: | ||
| Line 25: | Line 29: | ||
%list:moveFromId(%listId) | %list:moveFromId(%listId) | ||
return | return | ||
</p> | </p></ol> | ||
==See also== | ==See also== | ||
<ul><li><var>[[MoveFromId (Stringlist subroutine)|MoveFromId]]</var> which does the converse (move <var>$list</var> data into a <var>Stringlist</var>)</ul> | |||
{{Template:Stringlist:MoveToId footer}} | {{Template:Stringlist:MoveToId footer}} | ||
Revision as of 03:01, 27 January 2011
Move data from Stringlist to $list (Stringlist class)
This method moves data (stringlist items) from a stringlist to a $list. MoveToId is a subroutine that accepts one argument: the $list identifier of the $list to which data is to be moved. For more information about $list identifiers, see the Sirius Functions Reference Manual.
Syntax
sl:MoveToId( listId)
Syntax terms
| sl | A Stringlist object. |
|---|---|
| listId | The $list identifier of the $list to which data is to be moved. |
Usage notes
- All errors in MoveToId result in request cancellation.
- After MoveToId is invoked, the method Stringlist is emptied, although the object variable is still valid (non-null).
- MoveToId discards any current contents of the target $list.
- MoveToId copies to the target $list any image association that is set via BindImage.
- MoveToId simply moves the Stringlist internal data pointers to the to the target $list. It does not actually perform any data movement; therefore, it is extremely efficient.
- MoveToId is intended to facilitate the migration to the use of Stringlists of existing applications that use $lists.
- stringlists should always be used in preference to $lists, so MoveToId is provided only for the migration of existing $list applications to the use of stringlists.
Examples
- Suppose complex subroutine Summarize takes a $list identifier as its input parameter. Now, suppose some code that has a Stringlist in %list wants to pass the Stringlist to Summarize.
The following code illustrates how this can be accomplished:
%listid = $listnew %list:moveToId(%listId) call summarize(%listId) %list:moveFromId(%listId) return
See also
- MoveFromId which does the converse (move $list data into a Stringlist)