Differences

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

--- syntax:functions:right [2015/04/03 18:13] – elenap
+++ syntax:functions:right [2021/07/28 01:04] – craigt
@@ Line 1: / Line 1: @@
-===== Right(text, N) =====
+====== Right(text, no_of_chars) ======
+Category:  Text function
-Returns //N// right symbols of //text// where //N// is a number.
+\\
+=====Description=====
+This function returns the specified number of symbols from the right of //text// as a text value.
-First argument is implicitly converted into text, if required.
+\\
+=====Arguments=====
+^Argument^Type^Description^
+|text|Text|The text value to extract the symbols from.|
+|no_of_chars|Integer, minimum of 0|The number of symbols returned from the right side of the //text// argument.|
-^  Example  ^  Result  ^
+**Return value type:** Text
-|  right('(555)-555-5555', 8)  |  555-5555  |
-|  right('Consumer Products', 8)  |  Products  |
-**See also**
+\\
-  * [[syntax:functions:left]]
+=====Remarks=====
+Regardless of the type of value passed in for //text//, the result of this function is //always// a text value.
+Entering a //no_of_chars// of 0 will return an empty value.  Entering a //no_of_chars// greater than the length of //text// will result in the full //text// value being returned.
+Numbers and equations can be used as the //text// argument and are implicitly converted to their text-equivalent.  When passing in an equation for //text//, //no_of_chars// number of symbols from the equation's //result// will be returned.
+Passing in a date value (#yyyy-MM-dd) will return //no_of_chars// number of symbols from the converted date serial value.  See the examples below.
+\\
+=====Examples=====
+  right('Los Angeles', 3) = 'les'
+  right('IT services', 8) = 'services'
+  right('Canada',10) = 'Canada'
+  right('EasyMorph',0) = ''  //Empty value
+  right(12345, 3) = '345'  //Note, the numeric value of 12345 was passed in.  The result is a text value.
+  right(#2021-10-21, 3) = '490'  //2021-10-21 is 44490 as a converted date serial value, so '490' is returned.
+  right(100*3, 1) = '0'  //The result of 100 * 3 = 300, so the '0' is returned as the single rightmost character.
+\\
+===== See also =====
+  * [[syntax:functions:right]]
   * [[syntax:functions:mid]]