Difference between revisions of "SHIP:Sail:atoi"

Latest revision as of 10:05, 14 October 2016


Function	Returns	Introduced	Description
atoi	Integer	v5.0.120	Parses a String to get an Integer from it

Parameter	Data Type	Description
string	String	The string to parse
Return	Integer	the integer parsed value of the string

The atoi(string) function returns the Integer parsed value of a String which should contain the string version of an Integer.

Example	Result	Notes
`atoi("-5");`	-5
`atoi("+5");`	+5
`atoi("5.76");`	+5	Parsing stops at the first non-number, in this case the '.'
`atoi("57X");`	+57	Parsing stops at the X
`atoi("P57X");`	0	An error, parsing stops at the P*

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{SailFuncTableStart|}}<onlyinclude>
-|{{SailFunc|atoi}}||{{DataType|Integer}}||style="text-align:center;"|5.0.120||Parses a {{DataType|String}} to get an {{DataType|Integer}} from it{{v5}}</onlyinclude>
+|{{SailFunc|atoi}}||{{DataType|Integer}}||style="text-align:center;"|v5.0.120||Parses a {{DataType|String}} to get an {{DataType|Integer}} from it </onlyinclude>
 |}
 == See Also: ==
@@ Line 7: / Line 7: @@
 *[[SHIP:Sail:Functions|Sail Functions]]
 *[[SHIP:Sail:Numeric Functions|Sail Numeric Functions]]
+*[[SHIP:Sail:String_Functions|Sail String Functions]]
 *{{SailFunc|atof}}, {{SailFunc|ftoi}}, {{SailFunc|itof}}
 == Prototype ==
@@ Line 44: / Line 46: @@
 *try/catch is targeted for introduction in SHIP v5.1 to detect this condition.
+[[Category:Numeric Functions]]
+[[Category:String Functions]]