Replace (String function): Difference between revisions
Jump to navigation
Jump to search
m (subString and full stop) |
m (printtext and fix number -> count in syntax terms) |
||
| Line 16: | Line 16: | ||
<td>A string that contains the characters that replace the specified <var class="term">substring</var>. If <var class="term">replacement</var> is:<ul><li><b><i>not specified</i></b>, <var class="term">%outstring</var> is set to a copy of <var class="term">string</var>;<li><b><i>longer than 255 characters</i></b>, the request is cancelled;<li><b><i>null</i></b>, the <var class="term">substring</var> characters are removed from <var class="term">string</var>.</ul></td></tr> | <td>A string that contains the characters that replace the specified <var class="term">substring</var>. If <var class="term">replacement</var> is:<ul><li><b><i>not specified</i></b>, <var class="term">%outstring</var> is set to a copy of <var class="term">string</var>;<li><b><i>longer than 255 characters</i></b>, the request is cancelled;<li><b><i>null</i></b>, the <var class="term">substring</var> characters are removed from <var class="term">string</var>.</ul></td></tr> | ||
<tr><th>Count</th> | <tr><th>Count</th> | ||
<td>An optional, but <var>[[Methods#Named parameters|NameRequired]]</var>, argument that is the number of occurrences of <var class="term">substring</var> to replace. Only values greater than 0 are valid. If < | <td>An optional, but <var>[[Methods#Named parameters|NameRequired]]</var>, argument that is the number of occurrences of <var class="term">substring</var> to replace. Only values greater than 0 are valid. If <var class="term">count</var> is:<ul><li><b><i>less</i></b> than the number of occurrences of the <var class="term">substring</var>, only the first <var class="term">count</var> occurrences are substituted;<li><b><i>greater</i></b> than or <b><i>equal</i></b> to the number of occurrences of the <var class="term">substring</var>, all occurrences of the given <var class="term">substring</var> are substituted;<li><b><i>not specified</i></b>, all occurrences are substituted.</ul></td></tr> | ||
</table> | </table> | ||
| Line 22: | Line 22: | ||
<ul><li>The search for the target <var class="term">substring</var> is context sensitive; <b><i>case matters</i></b> in the attempt to find, as well as in the replacement of, the target characters. | <ul><li>The search for the target <var class="term">substring</var> is context sensitive; <b><i>case matters</i></b> in the attempt to find, as well as in the replacement of, the target characters. | ||
<li>Calling <var>Replace</var> with an empty replacement string argument is equivalent to using <var>[[Remove (String function)|Remove]]</var>. | <li>Calling <var>Replace</var> with an empty replacement string argument is equivalent to using <var>[[Remove (String function)|Remove]]</var>. | ||
<li><var>Replace</var> is available as of <var class="product">[[Sirius Mods]]</var> Version 7.3.</ul> | <li><var>Replace</var> is available as of <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.3.</ul> | ||
==Examples== | ==Examples== | ||
| Line 36: | Line 36: | ||
%repl = '?' | %repl = '?' | ||
%out = %x:replace(%substr, %repl, Count=2) | %out = %x:replace(%substr, %repl, Count=2) | ||
printText {~} is {%out} | [[PrintText statement|printText]] {~} is {%out} | ||
%substr = ' wood' | %substr = ' wood' | ||
| Line 50: | Line 50: | ||
==See also== | ==See also== | ||
{{Template:String:Replace footer}} | {{Template:String:Replace footer}} | ||
Revision as of 09:08, 23 February 2011
Replace occurrences of a substring with a substitute string (String class)
Th Replace intrinsic function replaces one, or multiple, occurrences of a substring within the method object input string with a substitute string, returning the modified version of the input string.
Syntax
%outString = string:Replace( substring, replacement, [Count= number])
Syntax terms
| %outString | A string variable to receive the modified input string. |
|---|---|
| string | The string to which the method is applied. |
| substring | The substring that the method attempts to replace in the input string. If string contains no occurrences of substring, %outstring is set to a copy of string. If substring is null or longer than 255 characters, the request is cancelled. |
| replacement | A string that contains the characters that replace the specified substring. If replacement is:
|
| Count | An optional, but NameRequired, argument that is the number of occurrences of substring to replace. Only values greater than 0 are valid. If count is:
|
Usage notes
- The search for the target substring is context sensitive; case matters in the attempt to find, as well as in the replacement of, the target characters.
- Calling Replace with an empty replacement string argument is equivalent to using Remove.
- Replace is available as of "Sirius Mods" Version 7.3.
Examples
- The following request shows two examples of Replace calls against the same input string: the first call replaces two occurrences of a specified substring; the second removes all occurrences of a different substring.
begin %x is longstring %substr is string len 6 %repl is string len 2 %out is longstring %x = 'How much wood would a woodchuck chuck' %substr = 'wo' %repl = '?' %out = %x:replace(%substr, %repl, Count=2) printText {~} is {%out} %substr = ' wood' %repl = '' %out = %x:replace(%substr, %repl) printText {~} is {%out} end
The request output follows:
%out is How much ?od ?uld a ?odchuck chuck %out is How much would achuck chuck