GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

DecimalToFloat Function

Overview

The DecimalToFloat function converts a string containing a decimal number to a floating-point value.

Syntax/Parameters

Syntax

float = DecimalToFloat ( string data | wstring data, [boolean sn_flag] );

Parameters

data

A string or wstring containing a decimal number.

sn_flag

An optional boolean value indicating whether to allow scientific notation. The default value is FALSE.

Return Value

Returns a float containing the float equivalent of value or 0.0 on failure. Use the GetLastError function to retrieve error information.

Remarks

The DecimalToFloat function converts a string containing a decimal number to a floating-point number. This should not be confused with the DecimalToInteger function, which converts a string containing a whole integer number.

This function handles the sign appropriately, decimal point and optionally scientific notation. The inclusion of any other characters aside from digits, sign, and decimal point will cause the DecimalToFloat function to fail.

Scientific notation can be used if it is in the form of:

n.n E [+ | -] nnn

Spaces are not allowed and the syntax is checked.

Because this function can return 0.0 as both a permissible value and as an error, use the GetLastError function to ensure the function succeeded.

If the string parameter cannot be converted to a float, the GetLastError function will return ERROR_SYNTAX.

Related Functions

CardinalToInteger — Converts a cardinal-style number to integer. For example: One 1, Eleven 11, 27, etc.

DecimalToInteger — Converts a decimal value to integer. It cannot contain commas or periods

FloatToString — Converts a floating point to a string with optional decimal places.

FormatString — Formats a string with embedded parameters for accounting, decimal, hex, etc.

HexToInteger — Converts a hex string to a 64-bit integer or quad word.

OctalToInteger — Converts an octal number to an integer.

RomanToInteger — Converts a clean roman number to an integer.

TextToInteger — Converts any integer-style to a number including hex and octal.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.