StringToFloat(String) Function

 Top 

Description

Returns the numeric value represented by stringArgument.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

 

Function Signature

StringToFloat(

String stringArgument)

 

 

Arguments

stringArgument

Description:

The string to be converted.

 

 

 

Return Value

Type:

number

 

 

Returns the numeric value of a string holding a series of numeric characters.

 

Syntax

myVariable1 = StringToFloat(myString1);

 

 

Example 1

The following example retrieves "123.456" from a String and saves it as a Variable.

 

Variable var1;

String str1;

str1 = "123.456";

var1 = StringToFloat(str1);

 

Report var1;

 

 

Output:

 

123.456000000

 

 

 

See also

StringToFloat