  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The GetParameter function returns the value portion of a “property name: value” pair referenced by the supplied property name in a list of parameters.
Syntax/Parameters
Syntax
string = GetParameter ( string data, string name, [string delimiter] );
Parameters
data
A string containing a series of property-value pairs. By default they are delimited as:
property-name: value; property-name: value; property-name: value; ...
The pair delimiter can be changed but is “;” by default.
name
A string containing the exact property name to locate, less the delimiting colon “:”. That name is case-sensitive.
delimiter
An optional string containing the delimiter by which to search through the property-value pairs. The default value is “;”,
Return Value
Returns a string containing the value corresponding to the matching of the property name or an empty string on failure. Use the GetLastError function to retrieve error information.
Remarks
This function can be used to pull a single value from a parameter string. The returned string can then be translated to other data types depending on its content.
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.