  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Sixteen — Application (continued)
Overview
The RegistryGetString function returns the value as specified by the key location and name as a string.
Syntax/Parameters
Syntax
string = RegistryGetString ( 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 string containing the data or empty on failure. Since an empty string 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 maximum size of the return string is 2MB characters.
The underlying data within the registry is always UNICODE and will be down converted to ANSI. This may result in the loss of character data.
If the data type is not a string, it will be converted to a string, if possible. For example, a dword type will be converted to hex. If the data cannot be converted, ERROR_CONTEXT will be returned as the error code.
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.