GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

GetNumericWholePortion Function

Overview

The GetNumericWholePortion function tests a string as being numeric and returns the whole number portion of the value as a string.

Syntax/Parameters

Syntax

string = GetNumericWholePortion ( string data );

Parameters

data

A string containing a formatted number.

Return Value

Returns a string containing whole number portion of the data parameter or an empty string on failure. Use the GetLastError function to retrieve error information.

On success, the last error will contain the count of the number of whole number digits (less sign).

Remarks

GetNumericWholePortion tests the incoming string for US accounting formatting, finds the decimal position and strips that section. If there is a syntax error, an empty string is returned and the error code placed in the last error. Not have a decimal portion is not an error, the returned string will be empty and last error set to 0.

While negative numbers may be represented with a ‘-’ or in parenthesis, a negative value will always return using a dash (‘-’). Currency values are not stripped and will result in a syntax error.

Related Functions 

DecimalToFloat — Converts to a floating-point number (64-bit).

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.

GetNumericDecimalPortion — Returns the decimal number portion of a numeric string.

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-10-21

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/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.