Differences

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

--- syntax:functions:asnumber [2015/01/29 22:23] – created dmitry
+++ syntax:functions:asnumber [2021/09/12 12:13] (current) – craigt
@@ Line 1: / Line 1: @@
-===== AsNumber(value) =====
+====== AsNumber(expression) ======
+Category:  Special function
-Converts the //value// to number.
+\\
+=====Description=====
+This function converts //expression// to a number.
-Text should have only digits and one decimal point.
+\\
+=====Use cases=====
+This is useful when you wish to validate the contents of a field or retrieve the number value of a field.
-Boolean is converted into -1 (true) or 0 (false).
+\\
+=====Arguments=====
+^Argument^Type^Description^
+|expression|Number, Text, Boolean|The value or result of an expression to be converted into a number value.|
-Number remains itself.
+**Return value type:** Number
+\\
+=====Remarks=====
+  * Text should have only digits and one decimal point.
+  * Boolean is converted into -1 (TRUE) or 0 (FALSE).
+  * Number remains itself.
+  * Everything else returns error.
+\\
+=====Examples=====
+  asnumber( '123.45' )  //Returns 123.45
+  asnumber( 543.21 )  //Returns 543.21
+  asnumber( 1 > 2 )  //Returns 0  (FALSE result of an expression.)
+  asnumber( 'text' )  //Returns '#Can't convert to number'
+\\
+=====See also=====
+  * [[syntax:functions:astext|AsText(expression)]]
-Everything else returns error.