MoveToId (Stringlist subroutine) - Revision history

JAL at 18:51, 31 October 2012

2012-10-31T18:51:11Z

← Older revision		Revision as of 18:51, 31 October 2012
Line 1:		Line 1:
	{{Template:Stringlist:MoveToId subtitle}}		{{Template:Stringlist:MoveToId subtitle}}

	This method moves data (<var>stringlist</var> items) from a <var>~~stringlist~~</var> to a ~~<var>~~$list~~</var>~~. <var>MoveToId</var> is a subroutine that accepts one argument: the ~~<var>~~$list~~</var>~~ identifier of the ~~<var>~~$list~~</var>~~ to which data is to be moved~~. For more information about <var>$list</var> identifiers, see the <var>[[Sirius Functions Reference Manual]]</var>~~.		This method moves data (<var>stringlist</var> items) from a <var>Stringlist</var> to a [[$lists\|$list]]. <var>MoveToId</var> is a subroutine that accepts one argument: the $list identifier of the $list to which data is to be moved.

	==Syntax==		==Syntax==
	{{Template:Stringlist:MoveToId syntax}}		{{Template:Stringlist:MoveToId syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<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>listId</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 $list identifier of the $list to which data is to be moved.</td></tr>
	</table>		</table>

Line 16:		Line 18:
	<ul><li>All errors in <var>MoveToId</var> result in request cancellation.		<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>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> discards any current contents of the target $list.
	<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>
			<li><var>MoveToId</var> copies to the target $list 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 $list. 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 $lists.

			<li><var>stringlists</var> should always be used in preference to $lists, so <var>MoveToId</var> is provided only for the migration of existing $list 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.		Suppose complex subroutine <code>Summarize</code> takes a $list identifier as its input parameter. Now, suppose some code that has a <var>Stringlist</var> in <code>%list</code> wants to pass the <var>Stringlist</var> to <code>Summarize</code>.
	The following code illustrates how this can be accomplished:		The following code illustrates how this can be accomplished:

Line 32:		Line 42:

	==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>		<ul>
			<li><var>[[MoveFromId (Stringlist subroutine)\|MoveFromId]]</var> does the converse operation (move $list data into a <var>Stringlist</var>)</ul>

	{{Template:Stringlist:MoveToId footer}}		{{Template:Stringlist:MoveToId footer}}

JAL2: /* Examples */

2012-05-02T23:09:58Z

Examples

← Older revision		Revision as of 23:09, 2 May 2012
Line 21:		Line 21:

	==Examples==		==Examples==
	~~<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.		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 29:		Line 29:
	%list:moveFromId(%listId)		%list:moveFromId(%listId)
	return		return
	</p~~></ol~~>		</p>

	==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>		<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}}

Goff: more consistent layout and better tagging

2011-01-27T03:01:22Z

more consistent layout and better tagging

← Older revision		Revision as of 03:01, 27 January 2011
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>~~listid~~</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 ~~the original~~ 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 ~~'''~~not~~'''~~ 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>~~Stringlist~~</var>s of existing applications that use $lists.<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>		<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}}

Wiccan: 1 revision

2011-01-26T18:56:24Z

1 revision

← Older revision	Revision as of 18:56, 26 January 2011
(No difference)

Goff: syntax digram, tags and links

2011-01-26T18:56:18Z

syntax digram, tags and links

← Older revision		Revision as of 18:56, 26 January 2011
Line 27:		Line 27:
	</p>		</p>

	~~[[Category~~:Stringlist ~~methods\|MoveTold subroutine]]~~		==See also==
			{{Template:Stringlist:MoveToId footer}}

Goff: syntax digram, tags and links

2011-01-26T08:40:12Z

syntax digram, tags and links

← Older revision		Revision as of 08:40, 26 January 2011
Line 1:		Line 1:
	{{Template:Stringlist:MoveToId subtitle}}		{{Template:Stringlist:MoveToId subtitle}}

	This method moves data (<var>~~Stringlist~~</var> items) from a <var>~~Stringlist~~</var> to a $list. <var>MoveToId</var> 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''.		This method moves data (<var>stringlist</var> items) from a <var>stringlist</var> to a <var>$list</var>. <var>MoveToId</var> is a subroutine that accepts one argument: the <var>$list</var> identifier of the <var>$list</var> to which data is to be moved. For more information about <var>$list</var> identifiers, see the <var>[[Sirius Functions Reference Manual]]</var>.

	==Syntax==		==Syntax==
Line 10:		Line 10:
	<td>A <var>Stringlist</var> object.</td></tr>		<td>A <var>Stringlist</var> object.</td></tr>
	<tr><th>listid</th>		<tr><th>listid</th>
	<td>The $list identifier of the $list 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 ~~the~~ <var>MoveToId</var> ~~method~~ is invoked, the method <var>Stringlist</var> is ~~empty~~, ~~though~~ the object variable is still valid (non-null).<li><var>MoveToId</var> discards the original contents of the target $list.<li>~~The~~ <var>MoveToId</var> ~~method~~ copies to the target $list any image association that is set via BindImage.<li><var>MoveToId</var> simply moves ~~the pointers to~~ the <var>Stringlist</var> data to the target $list. It does '''not''' 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>Stringlist</var>s of existing applications that use $lists. ~~For example~~, ~~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.		<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 the original 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 '''not''' 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>Stringlist</var>s of existing applications that use $lists.<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==
			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 23:		Line 26:
	return		return
	</p>		</p>

	~~<var>Stringlist</var>s should always be used in preference to $lists, so <var>MoveToId</var> is provided only for the migration of existing $list applications to the use of <var>Stringlist</var>s.~~
	~~</ul>~~

	[[Category:Stringlist methods\|MoveTold subroutine]]		[[Category:Stringlist methods\|MoveTold subroutine]]

Wiccan: 1 revision

2011-01-20T15:47:13Z

1 revision

← Older revision	Revision as of 15:47, 20 January 2011
(No difference)

Wiccan: 1 revision

2011-01-20T15:47:10Z

1 revision

← Older revision		Revision as of 15:47, 20 January 2011
Line 17:		Line 17:
	The following code illustrates how this can be accomplished:		The following code illustrates how this can be accomplished:

	<~~pre~~>		<p class="code">%listid = $listnew
	%listid = $listnew
	%list:moveToId(%listId)		%list:moveToId(%listId)
	call summarize(%listId)		call summarize(%listId)
	%list:moveFromId(%listId)		%list:moveFromId(%listId)
	return		return
	</~~pre~~>		</p>

	<var>Stringlist</var>s should always be used in preference to $lists, so <var>MoveToId</var> is provided only for the migration of existing $list applications to the use of <var>Stringlist</var>s.		<var>Stringlist</var>s should always be used in preference to $lists, so <var>MoveToId</var> is provided only for the migration of existing $list applications to the use of <var>Stringlist</var>s.

Wiccan: 1 revision

2011-01-19T16:12:32Z

1 revision

← Older revision	Revision as of 16:12, 19 January 2011
(No difference)

Wiccan: 1 revision

2011-01-19T16:12:29Z

1 revision

← Older revision		Revision as of 16:12, 19 January 2011
Line 1:		Line 1:
	{{Template:Stringlist:MoveToId subtitle}}		{{Template:Stringlist:MoveToId subtitle}}

	This method moves data (<var>Stringlist</var> items) from a <var>Stringlist</var> 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''.		This method moves data (<var>Stringlist</var> items) from a <var>Stringlist</var> to a $list. <var>MoveToId</var> 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==		==Syntax==
Line 14:		Line 14:

	==Usage notes==		==Usage notes==
	<ul><li>All errors in MoveToId result in request cancellation.<li>After the MoveToId method is invoked, the method <var>Stringlist</var> is empty, though the object variable is still valid (non-null).<li>MoveToId discards the original contents of the target $list.<li>The MoveToId method copies to the target $list any image association that is set via BindImage.<li>MoveToId simply moves the pointers to the <var>Stringlist</var> data to the target $list. It does '''not''' actually perform any data movement; therefore, it is extremely efficient.<li>MoveToId is intended to facilitate the migration to the use of <var>Stringlist</var>s of existing applications that use $lists. For example, 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.		<ul><li>All errors in <var>MoveToId</var> result in request cancellation.<li>After the <var>MoveToId</var> method is invoked, the method <var>Stringlist</var> is empty, though the object variable is still valid (non-null).<li><var>MoveToId</var> discards the original contents of the target $list.<li>The <var>MoveToId</var> method copies to the target $list any image association that is set via BindImage.<li><var>MoveToId</var> simply moves the pointers to the <var>Stringlist</var> data to the target $list. It does '''not''' 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>Stringlist</var>s of existing applications that use $lists. For example, 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 25:
	</pre>		</pre>

	<var>Stringlist</var>s should always be used in preference to $lists, so MoveToId is provided only for the migration of existing $list applications to the use of <var>Stringlist</var>s.		<var>Stringlist</var>s should always be used in preference to $lists, so <var>MoveToId</var> is provided only for the migration of existing $list applications to the use of <var>Stringlist</var>s.
	</ul>		</ul>

	[[Category:Stringlist methods\|MoveTold subroutine]]		[[Category:Stringlist methods\|MoveTold subroutine]]