GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

PoolSetPosition Function

Overview

The PoolSetPosition function sets the current write position within the pool.

Syntax/Parameters

Syntax

int = PoolSetPosition ( handle hPool, int position );

Parameters

hPool

A handle specifying the String Pool object.

position

An int specifying the character position in the pool.

Return Value

Returns an int as the last position or a formatted error code on failure.

Remarks

This function sets the current position (or last position) in the pool. If the position value is equal or greater than the size of the pool, an ERROR_RANGE error will be returned.

Related Functions

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

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

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

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

PoolAppendFile — Appends a file to a specified pool object.

PoolAppendFormattedString — Formats a string and then appends it to pool and returns pool offset.

PoolAppendNewLine — Appends one or more new lines.

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

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

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 10/21/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.