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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

IsCurrency Function

Overview

The IsCurrency function tests if a string or character contains accounting style characters.

Syntax/Parameters

Syntax

boolean = IsCurrency ( string value );

boolean = IsCurrency ( wstring value );

boolean = IsCurrency ( char value );

boolean = IsCurrency ( wchar value );

Parameters

value

A string, wstring or

a char, wchar to test. The character can be any type that will resolve to an integer.

Return Value

Returns TRUE if value contains accounting style characters or FALSE if it does not.

Remarks

The IsCurrency function operates in two basic modes: on a string or on a character. Either can be ANSI or Unicode.

For strings, the tested currency characters are dollars ($), pounds (£), yen (¥), euros (€) and cents (¢). In addition, commas (,), periods (.) dashes (-), and parenthesis will test positive.

For characters, the above currency characters are tested. If the character is in the Unicode range, then the Unicode currency set is also tested from 0x20A0 to 0x20CF.

The function checks for accounting and currency characters but does not evaluate their order in relation to currency values for correctness. To test US currency format, use the IsCurrencyFormatted function.

Related Functions

IsAccounting — Tests a string for accounting characters (i.e., -123 or (34,555.44)).

IsCurrencyFormatted — Tests a string as properly formatted currency (US, Euro, Pounds, Yen, cents).

IsCurrencyPrefix — Tests a string for currency leader (i.e., USD$ or CAN$) allowing for other ISO-4217 codes. Following number can be loosely formatted as accounting.

IsCurrencyProper — Tests a string for properly structured currency, i.e., €128,333, allowing for multiple commas and periods for US and European formats. It does not check the number of digits.

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 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.