Remove (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(33 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This [[Intrinsic classes|intrinsic]] function removes one or multiple occurrences of a specified substring
{{Template:String:Remove subtitle}}
from an input string (the                                                                               
method object), and it returns the modified version of the input string.                                 
                                                                                                         
The Remove function is available as of version 7.3 of the [[Sirius Mods]].                               
===Remove syntax===                                                                                     
  %outStr = string:Remove(substring [, Count=num])
===Syntax Terms===                                                                                       
<dl>                                                                                                     
<dt>%outStr                                                                                             
<dd>A string variable to receive the modified input string.                                             
<dt>string                                                                                               
<dd>The string to which the method is applied.                                                           
<dt>substring                                                                                           
<dd>The substring that the method attempts to remove in the input string. If ''string'' contains no occurrences of ''substring'', ''%outStr'' is set to a copy of ''string''.     
                                                                                                         
If ''substring'' is null or longer than 256 characters, the request is cancelled.                       
<dt>Count=num                                                                                           
<dd>An optional, name-required, argument that is the number of occurrences of ''substring'' to remove. Only values greater than 0 are valid.                                                                   
                                                                                                         
If ''num'' is                                                         
*less than the number of occurrences of the substring, only the first ''num'' occurrences are removed.
*greater than or equal to the number of occurrences of the substring, all occurrences of the given substring are removed.
*not specified, all occurrences are removed.                                   
                                                                                                         
</dl>                                                                                                   
===Usage Notes===
*The search for the target substring is context sensitive; case  matters in the attempt to find and remove the target characters.
*The Remove method is equivalent to calling the [[Replace (String function)|Replace]] method with an empty replacement string argument.
===Examples===                                                                             
                                                                                           
The following request shows two examples of Remove calls against the same input string: the first call removes an occurrence of a specified substring; the second removes both occurrences of a different substring.                               
    begin                                                                                   
    %x is longstring                                                                       
    %substr is string len 6                                                                 
    %repl is string len 2                                                                   
    %out is longstring                                                                     
                                                                                           
    %x = 'Remove me'                                                                       
    %substr = ' me'                                                                         
    %out = %x:remove(%substr)                                                               
    [[Intrinsic classes#printtext|printText]] {~} is {%out}                                         
                                                                                           
    %substr = 'e'                                                                           
    %out = %x:remove(%substr, Count=2)                                                     
    printText {~} is {%out}                                                                
                                                                                           
The request output follows:                                                                 
    %out is Remove                                                                         
    %out is Rmov me


===See also===                                                                             
The <var>Remove</var> [[Intrinsic classes|intrinsic]] function removes one or multiple occurrences of a specified substring from the method object (input) string, returning the modified version.
[[List of intrinsic String methods]]


[[Category:Intrinsic String methods|Remove function]]
==Syntax==
[[Category:Intrinsic methods]]
{{Template:String:Remove syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%outString</th>
<td>A string variable to receive the modified method object (input) <var class="term">string</var>.</td></tr>
<tr><th>string</th>
<td>The method object (that is, input) <var class="term">string</var> to which the method is applied.</td></tr>
<tr><th>substring</th>
<td>The substring that the method attempts to remove in the method object <var class="term">string</var>. If <var class="term">string</var> contains no occurrences of <var class="term">substring</var>, <var class="term">%outString</var> is set to a copy of <var class="term">string</var>.  If <var class="term">substring</var> is null or longer than 256 characters, the request is cancelled.</td></tr>
<tr><th><var>Count</var></th>
<td>An optional, name-required, argument that is the number of occurrences of <var class="term">substring</var> to remove. Only values greater than 0 are valid.  If <i>number</i> is:<ul><li><b><i>less</i></b> than the number of occurrences of the <var class="term">substring</var>, only the first <i>number</i> occurrences are removed.<li><b><i>greater</i></b> than or <b><i>equal to</i></b> the number of occurrences of the  <var class="term">substring</var>, all occurrences of the given  <var class="term">substring</var> are removed.<li><b><i>not specified</i></b>, all occurrences are removed.</ul></td></tr>
</table>
 
==Usage notes==
<ul><li>The search for the target  <var class="term">substring</var> is context sensitive; case  <b><i>matters</i></b> in the attempt to find and remove the target characters.
<li><var>Remove</var> is equivalent to calling <var>[[Replace (String function)|Replace]]</var> method with an empty replacement string argument.
<li><var>Remove</var> is available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.3.</ul>
 
==Examples==
The following request shows two examples of <var>Remove</var> calls against the same input string: the first call removes an occurrence of a specified <var class="term">substring</var>; the second removes both occurrences of a different <var class="term">substring</var>.
<p class="code">begin
  %x is longstring
  %substr is string len 6
  %repl is string len 2
  %out is longstring
 
  %x = 'Remove me'
  %substr = ' me'
  %out = %x:remove(%substr)
  [[PrintText statement|printText]] {~} is {%out}
 
  %substr = 'e'
  %out = %x:remove(%substr, Count=2)
  printText {~} is {%out}
end
</p>
The request output follows:
<p class="output">%out is Remove
%out is Rmov me
</p>
 
==See also==
{{Template:String:Remove footer}}

Latest revision as of 21:02, 5 November 2012

Remove the occurrences of a specified substring (String class)


The Remove intrinsic function removes one or multiple occurrences of a specified substring from the method object (input) string, returning the modified version.

Syntax

%outString = string:Remove( substring, [Count= number])

Syntax terms

%outString A string variable to receive the modified method object (input) string.
string The method object (that is, input) string to which the method is applied.
substring The substring that the method attempts to remove in the method object string. If string contains no occurrences of substring, %outString is set to a copy of string. If substring is null or longer than 256 characters, the request is cancelled.
Count An optional, name-required, argument that is the number of occurrences of substring to remove. Only values greater than 0 are valid. If number is:
  • less than the number of occurrences of the substring, only the first number occurrences are removed.
  • greater than or equal to the number of occurrences of the substring, all occurrences of the given substring are removed.
  • not specified, all occurrences are removed.

Usage notes

  • The search for the target substring is context sensitive; case matters in the attempt to find and remove the target characters.
  • Remove is equivalent to calling Replace method with an empty replacement string argument.
  • Remove is available as of Sirius Mods Version 7.3.

Examples

The following request shows two examples of Remove calls against the same input string: the first call removes an occurrence of a specified substring; the second removes both occurrences of a different substring.

begin %x is longstring %substr is string len 6 %repl is string len 2 %out is longstring %x = 'Remove me' %substr = ' me' %out = %x:remove(%substr) printText {~} is {%out} %substr = 'e' %out = %x:remove(%substr, Count=2) printText {~} is {%out} end

The request output follows:

%out is Remove %out is Rmov me

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=Remove_(String_function)&oldid=1490"