  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Seven — Math Functions (continued)
Overview
The Sign function tests the sign of the parameter and returns 1, 0 or -1 for positive, zero or negative, respectively.
Syntax/Parameters
Syntax
int = sign ( int value | float value | string value );
Parameters
value
An int, float or string as the value to be tested. If the value is a string, it will be converted to an integer or floating point number. See Remarks.
Return Value
Returns an int as 1, 0 or -1 for positive, zero or negative, respectively or a formatted error code on an error. Use the GetLastError or GetLastErrorMessage for additional information.
An error condition is only returned with using the function with a string parameter.
Remarks
The Sign function is a mathematical function that extracts the sign of a number.
Note that when using a string, it is trimmed and converted. If a syntax error in encountered, an formatted error code will be returned by the function.
Also note that this is different that the trig Sine function.
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.