Differences

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

--- syntax:functions:endswith [2021/08/12 18:18] – dmitry
+++ syntax:functions:endswith [2021/08/14 19:02] (current) – [See also] craigt
@@ Line 1: / Line 1: @@
-====== EndsWith(textA, textB) ======
+====== EndsWith(text, end_string) ======
+Category:  Text function
-A search function that is used to check if a string of text ends with specific text.
+\\
+=====Description=====
+This function is a search function used to check if a string (//text//) ends with a specific text value (//end_string//).  If so, this function returns TRUE.  Otherwise, it returns FALSE.
-It returns TRUE if //textA// ends with //textB//, otherwise it returns FALSE. This function is case sensitive.
+\\
+=====Arguments=====
+^Argument^Type^Description^
+|text|Text|Any text, or value that can implicitly converted to text.|
+|end_string|Text|The text string to search for at the end of //text//.|
-^  Example  ^  Result  ^
+**Return value type:** Boolean (TRUE/FALSE)
-| endswith( 'Motorola Inc.', 'Inc' )  |  FALSE |
-| endswith( 'Ruthless', 'less' )  |  TRUE |
-=== Remarks ===
+\\
-The function ignores trailing spaces in both arguments. See the example below.
+=====Remarks=====
+This function is case sensitive.
-^  Example  ^  Result  ^
+This function ignores trailing whitespace and other non-printing characters when matching //end_string// to the end of //text//.
-| endswith( 'Ruthless  ', 'less          ' )  |  TRUE |
+\\
+=====Examples=====
+  endswith( 'Motorola Inc.', 'Inc' ) //Returns FALSE
+  endswith( 'Ruthless', 'less' ) //Returns TRUE
+  endswith('Ruthless', 'LESS') //Returns FALSE  (unmatched due to case)
+\\
+===== See also =====
+  * [[syntax:functions:contains]|Contains(text, look_for)]]
+  * [[syntax:functions:find]|Find(text, look_for)]]
+  * [[syntax:functions:startswith]|StartsWith(text, start_string)]]
-=== See also ===
-  * [[syntax:functions:find]]
-  * [[syntax:functions:contains]]
-  * [[syntax:functions:startswith]]