Replace (Stringlist function) - Revision history

JAL: /* Usage notes */

2012-11-01T00:36:28Z

Usage notes

← Older revision		Revision as of 00:36, 1 November 2012
Line 18:		Line 18:

	==Usage notes==		==Usage notes==
	<ul><li>All errors in <var>Replace</var> result in request cancellation.<li>Before <var class="product">Sirius Mods</var> Version 6.6, it was a request-cancelling error to try to replace a <var>Stringlist</var> item with a string longer than the size limit of a <var>Stringlist</var> item: 6124 bytes. This limitation was eliminated in <var class="product">Sirius Mods</var> Version 6.6.<li><var>Replace</var> is extremely efficient if the <var>Stringlist</var> item size is not being changed (return value for <var>Replace</var> of 0), fairly efficient when a <var>Stringlist</var> item is being replaced with a shorter string (return value of 1), and can be fairly expensive when a <var>Stringlist</var> item is being replaced with a longer string (return value of 2). Replacement with a longer string can be expensive because it can result in the splitting of a <var>Stringlist</var> leaf page. Once a leaf page is split, it will not be merged back together, even if subsequent <var>[[RemoveItem (Stringlist function)\|RemoveItem]]</var> invocations make this possible. Because of this, heavy use of <var>Replace</var> calls that increase <var>Stringlist</var> item size (and <var>[[Insert (Stringlist function)\|Insert]]</var> and <var>~~[[RemoveItem (Stringlist function)\|~~RemoveItem]]</var>) can result in "sparse" <var>Stringlist</var>s which place an unnecessary burden on the buffer pool and CCATEMP. <var>Stringlist</var> compression can be achieved using <var>[[CopyItems (Stringlist function)\|CopyItems]]</var>.</ul>		<ul>
			<li>All errors in <var>Replace</var> result in request cancellation.

			<li>Before <var class="product">Sirius Mods</var> Version 6.6, it was a request-cancelling error to try to replace a <var>Stringlist</var> item with a string longer than the size limit of a <var>Stringlist</var> item: 6124 bytes. This limitation was eliminated in <var class="product">Sirius Mods</var> Version 6.6.

			<li><var>Replace</var> is extremely efficient if the <var>Stringlist</var> item size is not being changed (return value for <var>Replace</var> of 0), fairly efficient when a <var>Stringlist</var> item is being replaced with a shorter string (return value of 1), and can be fairly expensive when a <var>Stringlist</var> item is being replaced with a longer string (return value of 2). Replacement with a longer string can be expensive because it can result in the splitting of a <var>Stringlist</var> leaf page. Once a leaf page is split, it will not be merged back together, even if subsequent <var>[[RemoveItem (Stringlist function)\|RemoveItem]]</var> invocations make this possible. Because of this, heavy use of <var>Replace</var> calls that increase <var>Stringlist</var> item size (and <var>[[Insert (Stringlist function)\|Insert]]</var> and <var>RemoveItem</var>) can result in "sparse" <var>Stringlist</var>s which place an unnecessary burden on the buffer pool and CCATEMP. <var>Stringlist</var> compression can be achieved using <var>[[CopyItems (Stringlist function)\|CopyItems]]</var>.
			</ul>

	==See also==		==See also==
	{{Template:Stringlist:Replace footer}}		{{Template:Stringlist:Replace footer}}

JALWiccan: 1 revision

2011-07-14T19:40:25Z

1 revision

← Older revision	Revision as of 19:40, 14 July 2011
(No difference)

JAL at 19:40, 14 July 2011

2011-07-14T19:40:22Z

← Older revision		Revision as of 19:40, 14 July 2011
Line 1:		Line 1:
	{{Template:Stringlist:Replace subtitle}}		{{Template:Stringlist:Replace subtitle}}

	This [[Notation conventions for methods#Callable ~~methods~~\|callable]] method replaces an existing <var>Stringlist</var> item with a string.		This [[Notation conventions for methods#Callable functions\|callable]] method replaces an existing <var>Stringlist</var> item with a string.

	==Syntax==		==Syntax==

JAL at 02:07, 9 March 2011

2011-03-09T02:07:45Z

← Older revision		Revision as of 02:07, 9 March 2011
Line 1:		Line 1:
	{{Template:Stringlist:Replace subtitle}}		{{Template:Stringlist:Replace subtitle}}

	This callable method replaces an existing <var>Stringlist</var> item with a string.		This [[Notation conventions for methods#Callable methods\|callable]] method replaces an existing <var>Stringlist</var> item with a string.

	==Syntax==		==Syntax==

Goff: syntax diagram, tags and links

2011-01-28T00:03:33Z

syntax diagram, tags and links

← Older revision		Revision as of 00:03, 28 January 2011
Line 11:		Line 11:
	<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>~~itemnum~~</th>		<tr><th>number</th>
	<td>The number of the item that is to be replaced.</td></tr>		<td>The number of the item that is to be replaced.</td></tr>
	<tr><th>string</th>		<tr><th>string</th>
	<td>A string that is to replace the ~~'''itemnum'''~~ <var>Stringlist</var> item.</td></tr>		<td>A string that is to replace the <var class="term">number</var> <var>Stringlist</var> item.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul><li>All errors in <var>Replace</var> result in request cancellation.<li>Before <var class=product>Sirius Mods</var> Version 6.6, it was a request-cancelling error to try to replace a <var>Stringlist</var> item with a ~~<var>Longstring</var>~~ longer than the size limit of a <var>Stringlist</var> item: 6124 bytes. This limitation was eliminated in <var class=product>Sirius Mods</var> Version 6.6.<li><var>Replace</var> is extremely efficient if the <var>Stringlist</var> item size is not being changed (return value for <var>Replace</var> of 0), fairly efficient when a <var>Stringlist</var> item is being replaced with a shorter string (return value of 1), and can be fairly expensive when a <var>Stringlist</var> item is being replaced with a longer string (return value of 2). ~~<var>Replace</var>ment~~ with a longer string can be expensive because it can result in the splitting of a <var>Stringlist</var> leaf page. Once a leaf page is split, it will not be merged back together, even if subsequent RemoveItem invocations make this possible. Because of this, heavy use of <var>Replace</var> calls that increase <var>Stringlist</var> item size (and Insert and RemoveItem) can result in "sparse" <var>Stringlist</var>s which place an unnecessary burden on the buffer pool and CCATEMP. <var>Stringlist</var> compression can be achieved using ~~the~~ [[CopyItems (Stringlist function)]].</ul>		<ul><li>All errors in <var>Replace</var> result in request cancellation.<li>Before <var class="product">Sirius Mods</var> Version 6.6, it was a request-cancelling error to try to replace a <var>Stringlist</var> item with a string longer than the size limit of a <var>Stringlist</var> item: 6124 bytes. This limitation was eliminated in <var class="product">Sirius Mods</var> Version 6.6.<li><var>Replace</var> is extremely efficient if the <var>Stringlist</var> item size is not being changed (return value for <var>Replace</var> of 0), fairly efficient when a <var>Stringlist</var> item is being replaced with a shorter string (return value of 1), and can be fairly expensive when a <var>Stringlist</var> item is being replaced with a longer string (return value of 2). Replacement with a longer string can be expensive because it can result in the splitting of a <var>Stringlist</var> leaf page. Once a leaf page is split, it will not be merged back together, even if subsequent <var>[[RemoveItem (Stringlist function)\|RemoveItem]]</var> invocations make this possible. Because of this, heavy use of <var>Replace</var> calls that increase <var>Stringlist</var> item size (and <var>[[Insert (Stringlist function)\|Insert]]</var> and <var>[[RemoveItem (Stringlist function)\|RemoveItem]]</var>) can result in "sparse" <var>Stringlist</var>s which place an unnecessary burden on the buffer pool and CCATEMP. <var>Stringlist</var> compression can be achieved using <var>[[CopyItems (Stringlist function)\|CopyItems]]</var>.</ul>

	==See also==		==See also==
	{{Template:Stringlist:Replace footer}}		{{Template:Stringlist:Replace footer}}

Wiccan: 1 revision

2011-01-26T18:56:24Z

1 revision

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

Wiccan: 1 revision

2011-01-26T18:56:18Z

1 revision

← Older revision		Revision as of 18:56, 26 January 2011
Line 20:		Line 20:
	<ul><li>All errors in <var>Replace</var> result in request cancellation.<li>Before <var class=product>Sirius Mods</var> Version 6.6, it was a request-cancelling error to try to replace a <var>Stringlist</var> item with a <var>Longstring</var> longer than the size limit of a <var>Stringlist</var> item: 6124 bytes. This limitation was eliminated in <var class=product>Sirius Mods</var> Version 6.6.<li><var>Replace</var> is extremely efficient if the <var>Stringlist</var> item size is not being changed (return value for <var>Replace</var> of 0), fairly efficient when a <var>Stringlist</var> item is being replaced with a shorter string (return value of 1), and can be fairly expensive when a <var>Stringlist</var> item is being replaced with a longer string (return value of 2). <var>Replace</var>ment with a longer string can be expensive because it can result in the splitting of a <var>Stringlist</var> leaf page. Once a leaf page is split, it will not be merged back together, even if subsequent RemoveItem invocations make this possible. Because of this, heavy use of <var>Replace</var> calls that increase <var>Stringlist</var> item size (and Insert and RemoveItem) can result in "sparse" <var>Stringlist</var>s which place an unnecessary burden on the buffer pool and CCATEMP. <var>Stringlist</var> compression can be achieved using the [[CopyItems (Stringlist function)]].</ul>		<ul><li>All errors in <var>Replace</var> result in request cancellation.<li>Before <var class=product>Sirius Mods</var> Version 6.6, it was a request-cancelling error to try to replace a <var>Stringlist</var> item with a <var>Longstring</var> longer than the size limit of a <var>Stringlist</var> item: 6124 bytes. This limitation was eliminated in <var class=product>Sirius Mods</var> Version 6.6.<li><var>Replace</var> is extremely efficient if the <var>Stringlist</var> item size is not being changed (return value for <var>Replace</var> of 0), fairly efficient when a <var>Stringlist</var> item is being replaced with a shorter string (return value of 1), and can be fairly expensive when a <var>Stringlist</var> item is being replaced with a longer string (return value of 2). <var>Replace</var>ment with a longer string can be expensive because it can result in the splitting of a <var>Stringlist</var> leaf page. Once a leaf page is split, it will not be merged back together, even if subsequent RemoveItem invocations make this possible. Because of this, heavy use of <var>Replace</var> calls that increase <var>Stringlist</var> item size (and Insert and RemoveItem) can result in "sparse" <var>Stringlist</var>s which place an unnecessary burden on the buffer pool and CCATEMP. <var>Stringlist</var> compression can be achieved using the [[CopyItems (Stringlist function)]].</ul>

	~~[[Category~~:Stringlist ~~methods\|~~Replace ~~function]]~~		==See also==
			{{Template:Stringlist:Replace footer}}

Wiccan: 1 revision

2011-01-20T15:46:16Z

1 revision

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

Wiccan: 1 revision

2011-01-20T15:46:11Z

1 revision

← Older revision		Revision as of 15:46, 20 January 2011
Line 18:		Line 18:

	==Usage notes==		==Usage notes==
	<ul><li>All errors in <var>Replace</var> result in request cancellation.<li>Before <var class=product>Sirius Mods</var> Version 6.6, it was a request-cancelling error to try to replace a <var>Stringlist</var> item with a Longstring longer than the size limit of a <var>Stringlist</var> item: 6124 bytes. This limitation was eliminated in <var class=product>Sirius Mods</var> Version 6.6.<li><var>Replace</var> is extremely efficient if the <var>Stringlist</var> item size is not being changed (return value for <var>Replace</var> of 0), fairly efficient when a <var>Stringlist</var> item is being replaced with a shorter string (return value of 1), and can be fairly expensive when a <var>Stringlist</var> item is being replaced with a longer string (return value of 2). <var>Replace</var>ment with a longer string can be expensive because it can result in the splitting of a <var>Stringlist</var> leaf page. Once a leaf page is split, it will not be merged back together, even if subsequent RemoveItem invocations make this possible. Because of this, heavy use of <var>Replace</var> calls that increase <var>Stringlist</var> item size (and Insert and RemoveItem) can result in "sparse" <var>Stringlist</var>s which place an unnecessary burden on the buffer pool and CCATEMP. <var>Stringlist</var> compression can be achieved using the [[CopyItems (Stringlist function)]].</ul>		<ul><li>All errors in <var>Replace</var> result in request cancellation.<li>Before <var class=product>Sirius Mods</var> Version 6.6, it was a request-cancelling error to try to replace a <var>Stringlist</var> item with a <var>Longstring</var> longer than the size limit of a <var>Stringlist</var> item: 6124 bytes. This limitation was eliminated in <var class=product>Sirius Mods</var> Version 6.6.<li><var>Replace</var> is extremely efficient if the <var>Stringlist</var> item size is not being changed (return value for <var>Replace</var> of 0), fairly efficient when a <var>Stringlist</var> item is being replaced with a shorter string (return value of 1), and can be fairly expensive when a <var>Stringlist</var> item is being replaced with a longer string (return value of 2). <var>Replace</var>ment with a longer string can be expensive because it can result in the splitting of a <var>Stringlist</var> leaf page. Once a leaf page is split, it will not be merged back together, even if subsequent RemoveItem invocations make this possible. Because of this, heavy use of <var>Replace</var> calls that increase <var>Stringlist</var> item size (and Insert and RemoveItem) can result in "sparse" <var>Stringlist</var>s which place an unnecessary burden on the buffer pool and CCATEMP. <var>Stringlist</var> compression can be achieved using the [[CopyItems (Stringlist function)]].</ul>

	[[Category:Stringlist methods\|Replace function]]		[[Category:Stringlist methods\|Replace function]]

Wiccan: 1 revision

2011-01-19T16:12:33Z

1 revision

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