  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The DataObjectSetSize function sets the end of position or size of the Data Object. If reallocation is required, it is automatically performed.
Syntax/Parameters
Syntax
int = DataObjectSetSize ( handle hData, int size );
Parameters
hData
A handle specifying the Data Object.
size
An int specifying the new size of the object. If the size exceeds the current allocation size, the object is reallocated using the default expansion method. If a no over-allocation is desired, change the sign of the value.
Return Value
Returns an int as the total bytes allocated within the Data Object or zero on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
The size parameter specifies the actual number of bytes used within the Data Object. The allocated size is normally higher and performed in 4K or 8K byte segments or even higher depending on how many times the script requests expansion. If the size parameter is set to a negative value, the function will overallocate by the minimum chunk.
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.