  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The FormatString function allows for multiple input parameters to be formatted into a string.
Syntax/Parameters
Syntax
string = FormatString ( string format, [mixed parameters ... ] );
wstring = FormatString ( wstring format, [mixed parameters ... ] );
Parameters
format
A string containing a template that specifies the structure of the resulting string. See Section 5.2 String Functions for information on creating formatted strings. The type of variable used determines the resulting type.
parameters
One or more parameters to be formatted and inserted into format.
Return Value
Returns a string or wstring formatted as specified or an empty string on failure. Use the GetLastError function to retrieve error information.
Remarks
Formatted strings allow numeric and other data to be formatted into a string for appropriate display. The format of the string and the data to be inserted depend upon the structure of the format parameter and the contents of the additional parameters passed to the function. For more information on formatted strings, see Section 5.2 String Functions.
For string type, the total size of the returned string cannot be larger than 2MB. If it exceeds 2MB, the returned string will be “--error--” with an error set in both the program runtime log and in the last error. For wstring type, the total size of the returned string cannot be larger than 1M characters.
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.