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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

PoolAppendFormattedString Function

Overview

The PoolAppendFormattedString function adds a formatted string to a String Pool Object.

Syntax/Parameters

Syntax

int = PoolAppendFormattedString ( handle hPool, string format, [parameters ...] );

Parameters

hPool

A handle specifying the String Pool Object.

format

A string containing a template that specifies the structure of the resulting string. See Section 5.1.3 for information on creating formatted strings.

parameters

Zero or more parameters to be formatted and inserted into format. If no parameters are supplied, the template is simply passed through to the result string.

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 PoolAppendFormattedString function operates in the same manner as the PoolAppend function, but it allows formatted strings to be added to the pool directly.

Related Functions

FormatString — Formats a string with embedded parameters for accounting, decimal, hex, etc.

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

PoolAppendAsXString — Appends a string at the current position while processing for XML and returns pool offset.

PoolAppendAsPCData — Appends a string at the current position while processing for PCDATA and returns pool offset.

PoolAppendFile — Appends a file to a specified pool object.

PoolGetPosition — Returns the end/current position of the pool.

PoolSetPosition — Sets the end/write position of the pool.

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.