  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The CardinalToInteger function converts a string containing a cardinal number into an integer value.
Syntax/Parameters
Syntax
int = CardinalToInteger ( string value );
Parameters
value
A string containing a cardinal number.
Return Value
Returns an int containing the integer equivalent of value or 0 on failure. Use the GetLastError function to retrieve error information.
Remarks
The value parameter is case-insensitive. If the string parameter cannot be converted to an integer, the GetLastError function will return ERROR_SYNTAX. The CardinalToInteger function tolerates a certain amount of incorrect syntax, but some poorly constructed cardinal numbers will produce an integer, though not necessarily the correct one. In these cases, because the CardinalToInteger function was able to translate the cardinal number into an integer, it will not produce an error. It is important to ensure in as much is possible that the value parameter is syntactically correct.
Negative numbers are not permitted.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 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.