  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Sixteen — Application (continued)
Overview
The RegistryGetFloat function returns the value as specified by the key location and name as a 64-bit floating-point value. The value name must contain a 64-bit REG_QWORD formatted as a floating-point value.
Syntax/Parameters
Syntax
float = RegistryGetFloat ( string key, string name );
Parameters
key
A string containing the name of the key to access.
name
A string containing the name of the value to access. If the value is an empty string, the default value for the key is returned.
Return Value
A float containing the data or 0.0 on failure. Since 0.0 can be returned, the last error must be checked using the GetLastError or IsError functions.
Typical underlying errors codes are ERROR_PATH_NOT_FOUND (3) when the key is not found and ERROR_FILE_NOT_FOUND (2) and the value name is not found.
Remarks
The registry does not have a native ‘float’ data type. Therefore, a 64-bit binary REG_QWORD is employed to store the data. If the value is not written correctly, the return result will be erroneous. If the source type is not corrected, an ERROR_SYNTAX will be returned.
If the registry data is not in floating-point format, the result could be erroneous or return a variation of NaN (Not a Number).
The script/user must have access rights to the specified key and value.
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.