Differences

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

--- syntax:functions:sanitize [2017/12/23 09:07] – created dmitry
+++ syntax:functions:sanitize [2021/08/02 04:17] – craigt
@@ Line 1: / Line 1: @@
-===== sanitize(text) =====
+====== Sanitize(text) ======
+Category:  Text function
-Replaces tabs and line breaks with spaces and removes hidden system characters with ASCII codes 0 to 31.
+\\
+=====Description=====
+This function replaces tabs and line breaks with spaces and removes hidden system characters with ASCII codes 0 to 31 in //text//.
+\\
+=====Use cases====
+This function can be used to remove unexpected unseen characters from text.
+\\
+=====Arguments=====
+^Argument^Type^Description^
+|text|Text|The text string to clean of non-printing characters (tabs line feeds, etc.).|
+**Return value type:** Text
+\\
+=====Examples=====
+This example shows the effects of //Sanitize//.
+First, check the length of a string, including a tab character:
+  len('Steven' & char(9)) = 7  //Length of 'Steven' (6) plus the tab
+The sanitized result is the same length, but the tab character has been converted to a trailing space:
+  len(sanitize('Steven' & char(9))) = 7
+  sanitize('Steven' & char(9)) = 'Steven '