Differences

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

--- syntax:functions:startswith [2015/03/20 21:16] – elenap
+++ syntax:functions:startswith [2021/08/14 19:01] (current) – craigt
@@ Line 1: / Line 1: @@
-====== StartsWith(textA, textB) ======
+====== StartsWith(text, start_string) ======
+Category:  Text function
-True, if first text string (textA) starts with the other (textB). Case sensitive.
+\\
+=====Description=====
+This function is a search function used to check if a string (//text//) starts with a specific text value (//start_string//).  If so, this function returns TRUE.  Otherwise, it returns FALSE.
-^  Example  ^  Result  ^
+\\
-| startswith( 'Crimea', 'Crime' )  |  True |
+=====Arguments=====
-| startswith( 'IBM', 'i' )  |  False |
+^Argument^Type^Description^
+|text|Text|Any text, or value that can implicitly converted to text.|
+|start_string|Text|The text string to search for at the beginning of //text//.|
-=== See also ===
+**Return value type:** Boolean (TRUE/FALSE)
-  * [[syntax:functions:endswith]]
-  * [[syntax:functions:find]]
+\\
-  * [[syntax:functions:contains]]
+=====Remarks=====
+This function is case sensitive.
+This function ignores leading whitespace and other non-printing characters when matching //start_string// to the beginning of //text//.
+\\
+=====Examples=====
+  startswith( 'Crimea', 'Crime' ) //Returns TRUE
+  startswith( 'IBM', 'i' ) //Returns FALSE (unmatched due to case)
+  startswith('    Ruthless', ' Ruth') //Returns TRUE (leading whitespace ignored)
+\\
+===== See also =====
+  * [[syntax:functions:contains]|Contains(text, look_for)]]
+  * [[syntax:functions:find]|Find(text, look_for)]]
+  * [[syntax:functions:endswith]|EndsWith(text, end_string)]]