  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The LayerStringSegment function lays one string on top on another string. The zero terminator of the source string is not layered.
Syntax/Parameters
Syntax
string = LayerStringSegment ( string target, string insert, int position );
Parameters
target
A target string upon which a string will be layered.
insert
A string to layer.
position
An int containing a zero-based position at which the string will be layered.
Return Value
Returns a string with target and insert combined at position or an empty string on failure. Use the GetLastError function to retrieve error information.
Remarks
The LayerStringSegment function layers one string on top of another at a specified character position. For example, layering the string “123” on top of the string “abcdef” at position 3 produces “abc123”. If position was beyond the end of the target string or if the size of the insert string when added to position exceeds the length of the target string, the GetLastError function will return ERROR_RANGE. The return string has a maximum size of 2MB. If the buffer is exceeded, the GetLastError function will return ERROR_OVERFLOW.
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.