  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The GetLineSize function will return the size in bytes of a line of text from a Mapped Text or Edit Object.
Syntax/Parameters
Syntax
int = GetLineSize ( handle hObject, int index, [boolean realized] );
Parameters
hObject
A handle to a valid Mapped Text or Edit Object.
index
An int containing a zero-based index to the line of data within the Mapped Text Object.
realized
An optional boolean flag, when set to TRUE forces the function to return the size as a realized value. The default is FALSE.
Return Value
Returns an int containing the number of characters for the specified line or -1 on failure. Use the GetLastError function to retrieve error information.
Remarks
The GetLineSize function returns the “native” or “realized” size of the line, that is, with or without tab expansion.
This function is only applicable to text type edit objects.
If the hObject parameter is invalid, the GetLastError function will return ERROR_FILE | ERROR_INVALID_HANDLE.
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.