GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

PoolCreate Function

Overview

The PoolCreate function creates a String Pool Object.

Syntax/Parameters

Syntax

handle = PoolCreate ( [string data] );

Parameters

data

An optional string containing data to initially populate the pool.

Return Value

Returns a handle representing a String Pool Object or NULL_HANDLE on failure. Use the GetLastError function to retrieve error information.

Remarks

The created String Pool Object automatically starts with 256K bytes of allocated space. The memory is held until the object is closed using the CloseHandle function.

Related Functions

CloseHandle — Closes an object handle and releases any associated resources.

PoolAppend — Appends a string at the current position and returns pool offset.

PoolPut — Places a string into the pool with an extra zero delimiter and returns pool offset.

PoolGetPool — Returns the entire pool as a string. This requires the pool to be a contiguous string.

PoolWriteFile — Writes the pool content to a specified file.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 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.