  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The PoolPut function writes a string to the pool but terminates the current string in the String Pool Object (as required).
Syntax/Parameters
Syntax
int = PoolPut ( handle hPool, string value );
Parameters
hPool
A handle specifying the String Pool Object.
value
A string to put into the pool.
Return Value
Returns an int containing the offset (location) where the appended string starts within the pool or a formatted error code on failure.
Remarks
The PoolPut function is useful for parceling the pool. However, using this function means that the pool cannot be accessed as a simple string. The offset returned can be used to later reference information put into the pool in this way.
When using the PoolPut function in a new pool, it is useful to place a placeholder string at position 0 to avoid having the zeroeth item be confused with empty items. For example, if an array of integers contains offsets to a pool, uninitialized items will be ‘0’ which could be inferred as a valid position.
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.