  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The FieldFromParameters function creates a field string on-the-fly without a Field Object by taking a list of properties and converting it into a field tag.
Syntax/Parameters
Syntax
string = FieldFromParameters ( string data[] );
Parameters
data
A string array containing the field type and the parameters to create the field.
Return Value
A string containing the field tag or an empty string on failure. Use the GetLastError function to retrieve a formatted error code.
The code ERROR_SYNTAX indicates that the field key name in the data parameter is not ‘Field’. The code ERROR_RANGE indicates that the parameter for field name is not known. The lower byte of the formatted error code will contain the key index that is causing the error.
Remarks
The data parameter must be formatted with each key name being a known properties name. The first entry must be ‘Field’ with a known field type name. For example:
string list[20];
string s1;
int rc;
list["Field"] = "Set";
list["Name"] = "File";
list["Value"] = "abc.txt";
s1 = FieldToParameters(list);
rc = GetLastError();
AddMessage("Result : 0x%08X", rc);
AddMessage("Result : %s", s1);
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.