Differences

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

--- syntax:functions:remove [2021/07/21 15:32] – craigt
+++ syntax:functions:remove [2021/07/21 16:18] – [Examples] craigt
@@ Line 1: / Line 1: @@
-====== Remove(text, N_start, N_chars) ======
+====== Remove(text, start_pos, no_of_chars) ======
 Category:  Text function
@@ Line 6: / Line 6: @@
 This function removes a specified number of characters, from a specified starting point, within a text string.
+**Return value type:**  Text
 \\
 =====Arguments=====
-^Argument^Description^
+^Argument ^Type ^Description^
-|text|Any text string or value that can implicitly be converted to text.|
+|text |Text|Any text string or value that can implicitly be converted to text.|
-|N_start|The N<sup>th</sup> position of the first character in //text// to start removing from.  The minimum value is 1.|
+|start_pos |Integer greater than 0|The N<sup>th</sup> position of the first character in //text// to start removing from.  The minimum value is 1.|
-|N_chars|The number of characters to remove.|
+|no_of_chars |Integer greater than 0 |The number of characters to remove.|
 \\
-====Return value type====
-Text
-\\
 =====Remarks=====
 All three arguments must be supplied or a warning applies in each row of the column.
-If //N_start// is a position past the end of the text, nothing is removed.
+If //start_pos// is a position past the end of the text, nothing is removed.
-If //N_chars// exceeds the number of characters that can be removed, all characters from //N_start// to the end of //text// will be removed.
+If //no_of_chars// exceeds the number of characters that can be removed, all characters from //start_pos// to the end of //text// will be removed.
@@ Line 28: / Line 26: @@
 =====Examples=====
-  remove('27.03.2015', 6, 5)  =  '27.03'
+  remove('27.03.2015', 6, 5) = '27.03'
-  remove('27.03.2015', 7, 2)  =  '27.03.15'
+  remove('27.03.2015', 7, 2) = '27.03.15'
   remove('Mrs. Smith", 3, 1) = 'Mr. Smith'
   remove(1203, 2, 2) = '13'
-  remove((10*10), 1, 1) = '00'  (removes the first single character from '100')
+  remove((10*10), 1, 1) = '00'  //removes the first single character from '100'.
-  remove('Alexander', 12, 2) = 'Alexander'  (N_start is past the end of the text - nothing is removed)
+  remove('Alexander', 12, 2) = 'Alexander'  //N_start is past the end of the text - nothing is removed.
-  remove('Scott', 4, 4) = 'Sco'  (N_chars extends past the end of text; only available characters are removed)
+  remove('Scott', 4, 4) = 'Sco'  //N_chars extends past the end of text; only available characters are removed.
 \\
 ===== See also =====
   * [[syntax:functions:mid]]