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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

PoolWriteFile Function

Overview

The PoolWriteFile function writes the entire contents of a String Pool Object to a file.

Syntax/Parameters

Syntax

int = PoolWriteFile ( handle hPool, string name );

Parameters

hPool

A handle specifying the String Pool Object.

name

A string containing a qualified filename with path.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure.

Remarks

The PoolWriteFile function does not warn of overwriting an existing file. The script must have access rights to create and write to the file path.

Related Functions

PoolCreate — Creates a String Pool Object (SPO) and optionally loads the pool with a string.

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

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

PoolAppendFile — Appends a file to a specified pool object.

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.