Remove (String function)
This intrinsic function removes one or multiple occurrences of a specified substring 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
- %outStr
- 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 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.
- Count=num
- 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.
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 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)
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