SHIP:Sail:atod

From Serious Documentation
Revision as of 09:43, 29 September 2016 by CarltonHeyer (talk | contribs) (Created page with "__NOTOC__ {{SailFuncTableStart|}}<onlyinclude> |{{SailFunc|atod}}||{{DataType|Double}}||style="text-align:center;"|5.1.0||Parses a {{DataType|String}} to get a {{DataType|Doub...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Function Returns Introduced Description
atod Double 5.1.0 Parses a String to get a Double from it Badge SHIPv5.gif

See Also:

Prototype

Double atod(String string);

Parameters/Return Value

Parameter Data Type Description
string String The string to parse
Return Double the double parsed value of the string

Detailed Description

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

Examples

Example Result Notes
atod("-5"); -5
atod("+5"); +5
atod("5.76"); +5 Parsing stops at the first non-number, in this case the '.'
atod("57X"); +57 Parsing stops at the X
atod("P57X"); 0 An error, parsing stops at the P*
  • try/catch is targeted for introduction in SHIP v5.1 to detect this condition.