Differences

This shows you the differences between two versions of the page.

--- syntax:functions:removechars [2016/06/20 11:38] – dmitry
+++ syntax:functions:removechars [2021/08/15 02:51] (current) – [See also] craigt
@@ Line 1: / Line 1: @@
-===== RemoveChars(text, string) =====
+======RemoveChars(text, chars) ======
+Category:  Text function
-Removes particular characters from the //text//.
+\\
+=====Description=====
+This function removes the individual characters specified in //chars// from //text//.
-^  Example  ^  Result  ^
+\\
-| removechars('a1b2c3', 'abc')  | 123  |
+=====Arguments=====
+^Argument^Type^Description^
+|text|Text|Any text value from which the characters in //chars// are removed.|
+|chars|Text|The set of individual characters to remove from //text//.|
+**Return value type:** Text
-=== See also ===
+\\
-  * [[syntax:functions:keepchars]]
+=====Remarks=====
-  * [[syntax:functions:removetext]]
+The individual characters listed in //chars// are removed from //text//, not just the whole value of //chars// as a string.
+All instances of each character in //chars// are removed.
+If none of the characters in //chars// appear in //text//, the whole value of //text// is returned.
+\\
+=====Examples=====
+  removechars('Jayne Mansfield', 'aeiou') //Returns 'Jayn Mnsfld'
+  removechars('Jane Goodall', 'al') //Returns 'Jne Good'
+  removechars('Jane Seymour','clk') //Returns 'Jane Seymour'
+  removechars(102102102,12) //Returns '000'  (Numbers are implicitly converted to text; value is returned as text)
+\\
+=====See also=====
+  * [[syntax:functions:remove|Remove(text, start, length)]]
+  * [[syntax:functions:removeend|RemoveEnd(text, length)]]
+  * [[syntax:functions:removestart|RemoveStart(text, length)]]
+  * [[syntax:functions:removetext|RemoveText(text, string)]]